PayZu GatewayCheckoutPlano e adesão

Consultar uma assinatura pela página

GET/v1/checkout/subscriptions/{subscription_id}

Confira o passo a passo → https://docs.payzu.com.br/docs/gateway/subscribe-to-a-plan


Path Params

subscription_idstringobrigatório
ID da assinatura.

Headers

x-checkout-keystringobrigatório
Chave de checkout.
acceptstring
Formato da resposta.

Responses

200Sucesso
idstringID da assinatura.
codestringCódigo curto da assinatura.
statusstringStatus da assinatura.
activecanceledincomplete
namestringNome da assinatura.
amountintegerValor de cada ciclo, em centavos.
recurrencestringPeriodicidade da cobrança.
monthlybimonthlyquarterlysemiannualannual
payment_methodstringMeio de pagamento.
credit_cardpix
recurrence_modestringnative: a adquirente cobra cada ciclo no cartão; manual: cada ciclo gera uma fatura para pagar.
nativemanual
created_atstringData e hora da criação.
updated_atstringData e hora da última alteração.
recurrence_end_datestring | nullData final da recorrência; nula se não termina.
credit_cardobject | nullCartão da assinatura; nulo no Pix.
Campos do objeto 1
cardobjectCartão.
Campos do objeto 4
idstringID do cartão salvo.
last_digitsstringÚltimos 4 dígitos.
expirationstring | nullValidade do cartão.
holder_namestring | nullNome impresso no cartão.
billingobjectCiclos de cobrança.
Campos do objeto 3
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.
graceobject | nullCarência depois de um ciclo sem pagamento; nula sem carência.
Campos do objeto 1
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 1
reasonstring | nullMotivo do cancelamento.
initial_payment_failurerenewal_failureplan_changeinvoice_refundinvoice_chargebackcustomer_requestmerchant_requestother
merchantobjectQuem recebe o pagamento.
Campos do objeto 1
display_namestring | nullNome de exibição da conta, definido no painel do PayZu Gateway; nulo enquanto não há nome.
customerobjectQuem assina.
Campos do objeto 6
idstringID do cliente.
namestringNome do cliente.
emailstringE-mail do cliente, mascarado.
phonestring | nullCelular do cliente, mascarado.
documentstringCPF ou CNPJ do cliente, mascarado.
document_typestringTipo do documento.
cpfcnpj
planobject | nullPlano da assinatura.
Campos do objeto 7
idstringID do plano.
namestringNome do plano.
descriptionstringDescrição do plano.
amountintegerValor de cada ciclo, em centavos.
recurrencestringPeriodicidade da cobrança.
monthlybimonthlyquarterlysemiannualannual
payment_settingsobjectComo as assinaturas do plano podem ser pagas.
Campos do objeto 1
accepted_methodsarray of stringsMeios de pagamento aceitos.
credit_cardpix
checkoutobjectPágina de adesão do plano.
Campos do objeto 3
slugstring | nullSlug do plano na url da página.
logo_urlstring | nullLogotipo exibido na página.
redirect_urlstring | nullPara onde o cliente vai depois de pagar a adesão.
discountobject | nullDesconto dos primeiros ciclos, contando a adesão; nulo sem desconto.
Campos do objeto 4
typestringTipo do desconto.
fixed_amountpercentage
valueintegerDesconto: centavos ou porcentagem, conforme o tipo.
cyclesintegerCiclos com desconto, contando a adesão.
public_descriptionstring | nullTexto do desconto para o cliente.
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.
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.
429Limite por IP
status_codeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
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.

Linguagem

Credenciais API Key

Chave de checkout

curl --request GET \     --url https://api.sandbox.payzu.dev/v1/checkout/subscriptions/{subscription_id} \     --header 'x-checkout-key: SUA_CHAVE_DE_CHECKOUT' \     --header 'accept: application/json'
Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui. Ou escolha um exemplo:

application/json