PayZu GatewayAssinaturas
Consultar uma assinatura
GET/v1/subscriptions/{subscription_id}
Confira o passo a passo → https://docs.payzu.com.br/docs/gateway/look-up-subscriptions
Requisições recentes
Headers
Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.
Responses
200Sucesso
idstringID da assinatura.
codestringCódigo curto da assinatura.
statusstringStatus da assinatura.
activecanceledincompletenamestringNome da assinatura.
amountintegerValor de cada ciclo, em centavos.
recurrencestringPeriodicidade da cobrança.
monthlybimonthlyquarterlysemiannualannualpayment_methodstringMeio de pagamento.
credit_cardpixcreated_atstringData e hora da criação.
updated_atstringData e hora da última alteração.
credit_cardobject | nullCartão da assinatura; nulo no Pix.
Campos do objeto 1
cardobjectCartão.
Campos do objeto 4
idstring | nullID do cartão salvo; nulo quando o cartão não ficou salvo.
brandstring | nullBandeira.
last_digitsstringÚltimos 4 dígitos.
holder_namestring | nullNome impresso no cartão.
billingobjectCiclos de cobrança.
Campos do objeto 4
anchor_atstringData de referência dos ciclos.
next_atstring | nullData do próximo ciclo; nula na assinatura cancelada.
canceled_atstring | nullData e hora do cancelamento.
renewal_failuresintegerRenovações seguidas que falharam.
graceobject | nullCarência depois de um ciclo sem pagamento; nula sem carência.
Campos do objeto 2
started_atstringInício da carência.
ends_atstring | nullFim da carência: o limite para pagar a fatura do ciclo.
cancellationobject | nullCancelamento; nulo se a assinatura não está cancelada.
Campos do objeto 2
reasonstring | nullMotivo do cancelamento.
initial_payment_failurerenewal_failureplan_changeinvoice_refundinvoice_chargebackcustomer_requestmerchant_requestothernotestring | nullObservação do cancelamento.
previous_cancellationsarray of objectsCancelamentos desfeitos, do mais novo para o mais antigo; vazio se a assinatura nunca voltou de um cancelamento.
Campos de cada item 4
canceled_atstringData e hora do cancelamento.
reasonstring | nullMotivo do cancelamento.
initial_payment_failurerenewal_failureplan_changeinvoice_refundinvoice_chargebackcustomer_requestmerchant_requestothernotestring | nullObservação do cancelamento.
reactivated_atstringData e hora em que a assinatura voltou a active.
customerobjectCliente.
Campos do objeto 5
idstringID do cliente.
namestringNome do cliente.
emailstringE-mail do cliente.
documentstringCPF ou CNPJ do cliente.
document_typestringTipo do documento.
cpfcnpjplanobject | nullPlano de origem; nulo na assinatura avulsa.
Campos do objeto 2
idstringID do plano.
namestringNome do plano.
discountobject | nullDesconto dos primeiros ciclos, contando a adesão; nulo sem desconto.
Campos do objeto 5
typestringTipo do desconto.
fixed_amountpercentagevalueintegerDesconto: centavos ou porcentagem, conforme o tipo.
cyclesintegerCiclos com desconto, contando a adesão.
internal_descriptionstring | nullDescrição interna do desconto.
public_descriptionstring | nullTexto do desconto para o cliente.
metadataobject | nullSeus dados, em chave e valor; nulo sem metadata.
400Requisição inválida
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
401Chave ausente ou inválida
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
403Acesso negado
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
404Não encontrado
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, quando existe.
request_idstringID da chamada, para o suporte.
500Erro interno
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
request_idstringID da chamada, para o suporte.
Esta página ajudou?