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

​
plan_id
string
required
UUID do plano de assinatura.

​
Resposta

​
id
string
UUID do plano.
​
name
string
Nome de exibição do plano.
​
description
string
Descrição longa exibida ao assinante.
​
amount
string
Valor recorrente em centavos de BRL, armazenado como string (ex.: "4990" = R$ 49,90).
​
payment_methods
array
Métodos de pagamento permitidos. Cada entrada é um dos valores credit_card, boleto, pix.
​
payment_methods_no_tax
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.
​
frequency
string
Frequência de cobrança. Um dos valores weekly, biweekly, monthly, bimonthly, quarterly, semiannual, annual.
​
end_date
string
Timestamp ISO-8601 em que o plano deixa de gerar novas cobranças. null para planos perpétuos.
​
is_perpetual
boolean
true quando end_date é null.
​
account_name
string
Nome de exibição da conta do vendedor que possui o plano.
{
  "id": "8b0e9f4a-2b7d-4f3f-9d8a-1c2e3a4b5c6d",
  "name": "Clube do Café — Mensal",
  "description": "Receba um pacote de 250g por mês.",
  "amount": "4990",
  "payment_methods": ["credit_card", "pix"],
  "payment_methods_no_tax": ["pix"],
  "frequency": "monthly",
  "end_date": null,
  "is_perpetual": true,
  "account_name": "Café da Esquina LTDA"
}

​
Erros

StatusQuando
404Não existe nenhum plano com o plan_id informado.

​
Exemplos

curl https://api.dlpay.cloud/subscriptions/plan/8b0e9f4a-2b7d-4f3f-9d8a-1c2e3a4b5c6d/