Skip to main content
GET
Esta rota traz a configuração atual de um plano a partir do id. Use-a para conferir se o plano está disponível antes de levar o cliente ao checkout e para exibir nome, preço e imagem do plano na sua aplicação.

Quando usar

Antes de chamar

  • Tenha uma chave secreta gerada por usuário com a permissão visualizar assinaturas. Nos perfis padrão, são Owner, Manager, Operador e Visualizador. Os perfis Desenvolvedor e Financeiro recebem 403 (veja Permissões por perfil).
  • Tenha o id do plano, devolvido na criação ou na listagem.
Assinaturas não têm modo de teste: as cobranças são reais mesmo com a chave de teste. Veja como homologar em Assinaturas: visão geral.

Parâmetros de caminho

string
required
Identificador único do plano. Ex.: 2RhQg9M7ZCg3X3nMb9W1kX8Q.

Respostas

string
Identificador único do plano.
string
ID do merchant dono do plano.
string
Nome do plano. Ex.: Plano Premium Mensal.
number
Preço do plano, em reais: 99.9 significa R$ 99,90.
string
Código da moeda. Ex.: BRL.
string
Periodicidade: weekly (semanal), biweekly (quinzenal), monthly (mensal) ou custom (intervalo personalizado).
integer | null
Intervalo da recorrência personalizada, em dias corridos (ex.: 90 = a cada 90 dias). null quando o plano não é custom.
string | null
Data de término do plano (formato date-time). null quando não há data de término.
string | null
Mensagem exibida ao comprador. Ex.: Bem-vindo ao Plano Premium!.
string[]
Formas de pagamento aceitas. Ex.: ["credit_card"].
string | null
URL da imagem do plano.
string
Status do plano: active (aceita novas assinaturas) ou inactive (não aceita).
integer
Quantidade de assinaturas ativas no plano. Ex.: 150.
string
Data de criação (formato date-time).
string
Data da última atualização (formato date-time).
Para o negócio: os dados devolvidos aqui valem para novas assinaturas. Quem já assinou continua pagando o preço, a moeda e a periodicidade da data da contratação, mesmo que o plano tenha sido alterado depois. Para saber o que um assinante específico paga, consulte a assinatura em Consultar assinatura.

Erros comuns

Veja também

Planos

Recorrência, trial e status do plano.

Visão geral de assinaturas

Fluxo completo, do cliente à cobrança recorrente.

Ciclo de vida

Status, renovação, retentativas e cancelamento.

Webhooks de assinatura

Eventos enviados a cada etapa da assinatura.

Registrar cartão

Guarde o cartão no cofre antes de criar a assinatura.

Atualizar plano

Altere preço, nome ou trial para novas assinaturas.