PayZu GatewayAssinaturas

Listar as assinaturas

GET/v1/subscriptions

Confira o passo a passo → https://docs.payzu.com.br/docs/gateway/look-up-subscriptions


Query Params

statusstring enum
Filtra pelo status da assinatura.
plan_idstring
Assinaturas deste plano; as avulsas ficam de fora.
customer_idstring
Filtra pelo ID do cliente.
next_fromstring
Próximo ciclo a partir deste dia, no horário de Brasília.
next_tostring
Próximo ciclo até este dia, no horário de Brasília.
created_fromstring
Criados a partir deste dia, no horário de Brasília.
created_tostring
Criados até este dia, no horário de Brasília.
searchstring
Busca no código da assinatura e no nome, no e-mail ou no documento do cliente.
cursorstring
next_cursor da página anterior, como veio.
limitintegerPadrão: 100
Itens por página; sem ele, 100.

Headers

Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.

Responses

200Sucesso
itemsarray of objectsItens da página.
Campos de cada item 18
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
created_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_requestother
notestring | 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_requestother
notestring | 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.
cpfcnpj
planobject | 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_amountpercentage
valueintegerDesconto: 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.
next_cursorstring | nullCursor da próxima página; nulo na última.
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.
fieldsarray of objectsCampos recusados na validação.
Campos de cada item 2
namestringCaminho do campo recusado.
messagestringMotivo da recusa.
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.

Linguagem

Credenciais Bearer

Token de API

curl --request GET \     --url https://api.sandbox.payzu.dev/v1/subscriptions \     --header 'authorization: Bearer SEU_TOKEN' \     --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