PayZu GatewayPlanos
Listar os planos
GET/v1/plans
Confira o passo a passo → https://docs.payzu.com.br/docs/gateway/look-up-plans
Requisições recentes
Query Params
cursorstring
next_cursor da página anterior, como veio.
limitintegerPadrão: 100
Itens por página; sem ele, 100.
statusstring enum
Filtra pelo status do plano.
activeinactiverecurrencestring enum
Filtra pela periodicidade.
searchstring
Busca no nome do plano.
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.
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 13
idstringID do plano.
statusstringStatus do plano.
activeinactiveurlstringPágina de adesão do plano.
namestringNome do plano.
descriptionstringDescrição do plano.
amountintegerValor de cada ciclo, em centavos.
recurrencestringPeriodicidade da cobrança.
monthlybimonthlyquarterlysemiannualannualcreated_atstringData e hora da criação.
updated_atstringData e hora da última alteração.
payment_settingsobjectComo as assinaturas do plano podem ser pagas.
Campos do objeto 1
accepted_methodsarray of stringsMeios de pagamento aceitos.
credit_cardpixcheckoutobjectPá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 de cada assinatura, 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.
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.
Esta página ajudou?