Skip to main content
POST
Cancelar assinatura
Cancela uma assinatura. Use quando o cliente pede para parar de ser cobrado. A assinatura fica CANCELLED com cancellation_reason: USER_ACTION. Faturas open passam a void. Funciona em TRIAL, PENDING, ACTIVE ou PAST_DUE. Se o cliente já cancelou, a API devolve o mesmo resultado. Se o cancelamento foi por falha de pagamento, responde 409. Se o status não permitir cancelamento, responde 422. Erros comuns: 401/403 (credenciais ou produto Recorrência), 404 (não encontrada), 409 (já cancelada por falha de pagamento), 422 (status não permite cancelamento).

Authorizations

client-id
string
header
required
client-secret
string
header
required

Headers

client-id
string
required

ID público da credencial do merchant

client-secret
string
required

Secret da credencial do merchant

Path Parameters

subscriptionId
string<uuid>
required

Response

Assinatura cancelada

subscription_id
string<uuid>

Identificador da assinatura cancelada.

subscription_status
enum<string>

Status resultante (CANCELLED).

Available options:
CANCELLED
cancellation_reason
string | null
Example:

"USER_ACTION"

cancelled_at
string<date-time> | null

Data do cancelamento.