Skip to main content
POST
Cancelar Assinatura

Visão Geral

Cancele uma assinatura de duas formas: imediatamente (cliente perde acesso na hora) ou agendado para o fim do período pago (cliente mantém acesso até a data de renovação).

Cancelamento Imediato

O cliente perde acesso imediatamente e nenhuma cobrança futura será realizada.
Resultado:
  • Status muda para canceled
  • Acesso revogado imediatamente
  • Nenhuma cobrança futura

Cancelamento Agendado

O cliente mantém acesso até o fim do período pago atual.
Resultado:
  • Status muda para pending_cancellation
  • Cliente mantém acesso até currentPeriodEnd
  • Campo cancelAt preenchido com a data de cancelamento
  • No fim do período, status muda para canceled

Parâmetros

cancelImmediately
boolean
required
true = cancelamento imediato, false = cancelamento no fim do período.
reason
string
Motivo do cancelamento (opcional, para registro interno).

Resposta de Sucesso

Cancelamento Imediato (200 OK)

Cancelamento Agendado (200 OK)

Erros Comuns

Solução: Verifique se o ID da assinatura está correto.
Solução: A assinatura já foi cancelada anteriormente.

Próximos Passos

Pausar Assinatura

Pause temporariamente as cobranças

Webhooks

Receba notificações de cancelamento