PayZu GatewayRecorrência

Consultar planos


Nesta páginaConsulte o planoListe os planosErros desta operação

Leia um plano pelo id ou liste os planos da conta, do mais novo para o mais antigo.

Consulte o plano

bash
curl "https://api.sandbox.payzu.dev/v1/plans/plan_oOsn4Cs4eayZ3LoytwzErn" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"

Referência: Consultar um plano

O bloco checkout vem sempre, com null nos campos que o plano não tem. Sem desconto, discount vem null.

Liste os planos

bash
curl "https://api.sandbox.payzu.dev/v1/plans?status=active&recurrence=monthly&limit=20" \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"

Referência: Listar os planos

A resposta traz os planos em items, no formato da consulta, e o next_cursor da paginação, com limit de até 100.

FiltroO que traz
statusOs planos active ou os inactive. Sem ele, a lista traz os dois.
recurrenceOs planos dessa periodicidade.
searchOs planos com esse texto no nome, sem diferença entre maiúsculas e minúsculas.
created_from, created_toO dia da criação, em AAAA-MM-DD, no fuso de São Paulo.

O plano excluído não sai na lista e responde 404 na consulta. Parâmetro que a lista não tem é ignorado.

Erros desta operação

CódigoHTTPMensagem
-404Plano não encontrado para o id informado
PZ034404Recorrência não ativada para esta conta.

Os erros de autenticação e de validação estão no Catálogo de erros.