PayZu GatewayRecorrência
Consultar planos
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"json
{
"id": "plan_oOsn4Cs4eayZ3LoytwzErn",
"status": "active",
"url": "https://invoice.payzu.com.br/checkout/jdUWa_UHtX_7a-vtN_NChU7bug_IbxizyqDEN2X0000/plano-mensal",
"name": "Plano Mensal",
"description": "Acesso mensal à plataforma",
"amount": 15990,
"recurrence": "monthly",
"created_at": "2026-11-11T15:20:59.297Z",
"updated_at": "2026-11-11T15:20:59.297Z",
"payment_settings": {
"accepted_methods": ["credit_card", "pix"]
},
"checkout": {
"slug": "plano-mensal",
"logo_url": "https://loja.exemplo.com.br/logo.png",
"redirect_url": "https://loja.exemplo.com.br/obrigado"
},
"discount": {
"type": "percentage",
"value": 10,
"cycles": 3,
"internal_description": "Campanha de novembro",
"public_description": "10% nos 3 primeiros meses"
},
"metadata": {
"internal_id": "1234"
}
}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.
| Filtro | O que traz |
|---|---|
status | Os planos active ou os inactive. Sem ele, a lista traz os dois. |
recurrence | Os planos dessa periodicidade. |
search | Os planos com esse texto no nome, sem diferença entre maiúsculas e minúsculas. |
created_from, created_to | O 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ódigo | HTTP | Mensagem |
|---|---|---|
| - | 404 | Plano não encontrado para o id informado |
PZ034 | 404 | Recorrência não ativada para esta conta. |
Os erros de autenticação e de validação estão no Catálogo de erros.