Skip to main content
POST

Visão geral

Cancela a assinatura do usuário. Ela permanece ativa até o fim do período de cobrança atual e não será renovada. Exige autenticação por sessão (JWT de acesso).
Para integrações de terceiros: use POST /subscriptions/cancel/api com autenticação por chave de API.
O cancelamento é agendado para o fim do período. O acesso se mantém até currentPeriodEnd. Para cancelamento imediato, use o portal de cobrança.

Autenticação

string
obrigatório
Seu JWT de acesso. Formato: Bearer YOUR_ACCESS_TOKEN

Campos da resposta

boolean
Se o cancelamento foi bem-sucedido.
string
Mensagem de status legível.
string
Data e hora em ISO 8601 em que a assinatura terminará (apenas em caso de sucesso).

Respostas de erro

Requisição inválida — sem assinatura ativa ou cancelamento indisponível por API.
Não autorizado — token ausente ou inválido.

Comportamento do cancelamento

Reativação

Para reativar, o usuário pode:
  1. Usar o portal de cobrança (/subscriptions/portal)
  2. Ou contratar nova assinatura após o término da atual

Boas práticas

  • Diálogo de confirmação: confirme antes de cancelar
  • Motivo: colete o motivo para feedback
  • Retenção: considere desconto ou pausa
  • Comunicação: mostre claramente quando o acesso termina

POST /subscriptions/cancel/api

Cancela a assinatura com autenticação por chave de API. Indicado para integrações externas.

Autenticação

Resposta

Igual à de /subscriptions/cancel, acima.