Consultar plano
Devolve um plano da conta pelo id, com as opções de Pix Automático já preenchidas.
apiKeyAuthorizationBearer <token>Chave de API da conta: Authorization: Bearer <chave de API>.
id*stringId do plano.
O plano.
application/json- response
id?stringId do plano (ULID).
name?stringNome do plano.
comment?|Anotação interna.
amountCents?integerValor de cada ciclo em centavos.
currency?stringMoeda. Sempre BRL.
dayDue?|Dias até a cobrança de cada ciclo vencer (Pix).
type?PlanTypePIX_RECURRING para Pix Automático; RECURRENT para cartão.
"PIX_RECURRING""RECURRENT"frequency?PlanFrequencyPeriodicidade: semanal, mensal, semestral ou anual.
"WEEKLY""MONTHLY""SEMIANNUALLY""ANNUALLY"installmentCount?|Número de ciclos. null = contínua.
paymentMethods?array<>Meio de pagamento do plano.
pixRecurringOptions?|Opções do Pix Automático, já com os padrões aplicados. null em plano de cartão.
passthroughFees?booleanSe o repasse de tarifa está ligado.
isArchived?booleanSe o plano está arquivado. Plano arquivado não aceita assinatura nova nem edição.
createdAt?stringCriação, em UTC.
date-timeupdatedAt?stringÚltima alteração, em UTC.
date-timecurl -X GET 'https://api.gates2b.com/plan/string'{ "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"}Responde 404 se o plano não existe ou é de outra conta. Planos arquivados
também são devolvidos, com isArchived: true.