Planos
Listar planos
Lista os planos da conta, do mais recente para o mais antigo, com a contagem de assinaturas de cada um.
GET
apiKeyheader
AuthorizationBearer <token>Chave de API da conta: Authorization: Bearer <chave de API>.
includeArchived?booleantrue inclui os planos arquivados. Qualquer outro valor é tratado como false.
Padrão
falselimit?integerItens por página. Valores acima de 100 viram 100.
Intervalo
1 <= value <= 100Padrão
50offset?integerQuantos itens pular antes de começar a página.
Intervalo
0 <= valuePadrão
0Página de planos.
application/json- response
data*array<>total*integerQuantidade de itens nesta página, não o total da conta.
curl -X GET 'https://api.gates2b.com/plan'Example Response
{ "data": [ { "id": "01JB7Y2M3N4P5Q6R7S8T9V0W1X", "name": "Plano Mensal Premium", "comment": null, "amountCents": 9990, "currency": "BRL", "dayDue": null, "type": "PIX_RECURRING", "frequency": "MONTHLY", "installmentCount": null, "paymentMethods": [ "PIX" ], "pixRecurringOptions": { "journey": "ONLY_RECURRENCY", "retryPolicy": "THREE_RETRIES_7_DAYS" }, "passthroughFees": false, "isArchived": false, "createdAt": "2026-05-28T13:00:00.000Z", "updatedAt": "2026-05-28T13:00:00.000Z", "activeSubscriptionsCount": 12, "outdatedSubscriptionsCount": 0 } ], "total": 1}Exemplo
curl "https://api.gates2b.com/plan?includeArchived=true&limit=100&offset=0" \
-H "Authorization: Bearer $API_KEY"Regras
- Planos arquivados só aparecem com
includeArchived=true. - A página tem 50 itens por padrão e no máximo 100. Avance com
offset. totalé a quantidade de itens desta página, não o total da conta. Para saber se há mais páginas, peça a próxima até receber menos itens que olimit.activeSubscriptionsCountconta as assinaturas vigentes do plano;outdatedSubscriptionsCount, as ativas que cobram um valor diferente doamountCentsatual.