Endpoint: GET /subscriptions/plan/{plan_id}/
Autenticação: Público (sem autenticação)
Retorna a descrição pública de um plano de assinatura — nome, valor, métodos de pagamento aceitos, frequência, data de término e o nome de exibição do vendedor. Este é o endpoint que uma página de adesão hospedada chama primeiro para renderizar o cartão do plano antes de submeter POST /subscriptions/plan/{plan_id}/subscribe/. O plan_id é o UUID do plano. O plano não precisa estar em nenhum status específico para ser recuperado aqui, mas a chamada pública de adesão recusará planos expirados.

Pré-requisitos

  • Um plano de assinatura deve já existir. Planos são criados pelo vendedor via POST /subscriptions/seller/{seller_id}/plans/.

Parâmetros de rota

string
required
UUID do plano de assinatura.

Resposta

string
UUID do plano.
string
Nome de exibição do plano.
string
Descrição longa exibida ao assinante.
string
Valor recorrente em centavos de BRL, armazenado como string (ex.: "4990" = R$ 49,90).
array
Métodos de pagamento permitidos. Cada entrada é um dos valores credit_card, boleto, pix.
array
Métodos de pagamento para os quais o vendedor absorve a taxa. O fluxo de adesão cobrará sem taxa para esses métodos.
string
Frequência de cobrança. Um dos valores weekly, biweekly, monthly, bimonthly, quarterly, semiannual, annual.
string
Timestamp ISO-8601 em que o plano deixa de gerar novas cobranças. null para planos perpétuos.
boolean
true quando end_date é null.
string
Nome de exibição da conta do vendedor que possui o plano.

Erros

Exemplos