Autenticação: JWT bearer ou chave de API
account é definido pelo servidor a partir do parâmetro de rota seller_id — não envie esse campo no corpo. Opcionalmente cria a configuração de notificações aninhada na mesma chamada.
Pré-requisitos
- Quem chama precisa estar autenticado contra o vendedor identificado por
seller_id. - A conta do vendedor já precisa existir na plataforma.
Parâmetros de rota
UUID unificado da conta do vendedor que será dona do plano.
Corpo da requisição
Nome de exibição do plano.
Descrição longa exibida ao assinante na página pública do plano.
Valor recorrente em centavos de BRL, como string (ex.:
"4990" para R$ 49,90).Métodos que o assinante pode escolher. Valores permitidos:
credit_card, boleto, pix.Subconjunto de
payment_methods em que o vendedor absorve a taxa. Padrão [].Cadência de cobrança. Um dos valores
weekly, biweekly, monthly, bimonthly, quarterly, semiannual, annual.Timestamp ISO-8601. Omita (ou envie
null) para um plano perpétuo.Opcional. Persiste a configuração de notificações associada:
notify_new_payment_link(boolean, padrãotrue)days_before_due(integer, anulável) — dias antes do vencimento para notificar.notify_on_due_date(boolean, padrãotrue)days_after_overdue(integer, anulável) — dias após o vencimento para notificar.notify_payment_confirmed(boolean, padrãotrue)
Resposta
201 Created. Retorna o plano completo, incluindo os campos somente leitura account, metrics, is_perpetual, created_at, updated_at e o notification_config aninhado.
Inconsistência conhecida do campo
amount: o valor é tanto enviado quanto retornado como string em centavos, diferente da convenção em centavos inteiros adotada em outros endpoints.Erros
| Status | Quando |
|---|---|
400 | Validação falhou — campo obrigatório ausente, frequency inválido, método de pagamento inválido etc. |
401 | Token ausente ou inválido. |
403 | Chamador sem vínculo com este vendedor. |