Autenticação: JWT Bearer ou chave de API do vendedor — porém o método não é suportado nesta rota.
Cancelamento
Para cancelar a assinatura de um assinante, envie umPOST para a ação cancel no mesmo recurso:
- Define o status do assinante como
cancelede registracanceled_at = agora. - Atualiza em lote todos os pagamentos da assinatura desse assinante que estavam com
payment_status='pending'parapayment_status='canceled'. - Dispara a notificação de confirmação de cancelamento.
- Retorna
200com o assinante atualizado, ou400se o assinante já estiver cancelado.
POST /subscriptions/subscriber/{subscriber_id}/cancel/, que executa o mesmo fluxo.
Criação de assinantes
A criação de assinantes ocorre exclusivamente pelo fluxo público de adesão. Consulte Assinar plano (público) para criar um novo assinante e iniciar a cobrança da assinatura.Outras atualizações
Os campos de identidade do assinante (nome, e-mail, telefone, documento) são definidos no momento da criação, pelo fluxo público de adesão, e não podem ser alterados por esta API. Os camposnext_billing_date, last_payment_date e status são derivados da atividade de pagamentos e são atualizados automaticamente sempre que um pagamento da assinatura transita para paid, failed ou overdue.
Erros
| Status | Quando |
|---|---|
405 | PATCH ou PUT contra esta URL — sempre retornado. |
400 | Na ação cancel, quando o assinante já está cancelado. |
404 | O assinante não existe ou não pertence a este plano. |