Cancele uma assinatura
Cancele uma assinatura de imediato. Dispara o evento de webhook subscription.cancelled. Não pode ser desfeito.
POST /subscription/{id}/cancel cancela uma assinatura de imediato. Esta ação dispara o evento de webhook subscription.cancelled e não pode ser desfeita — a assinatura passa para o status cancelled de forma permanente. Se você quer parar o faturamento temporariamente sem perder a assinatura, use Pausar e retomar em vez disso.
Devolve 200 OK com o objeto de assinatura atualizado — status: "cancelled" e cancelledAt definido.
Erros
Autorizações
Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).
Parâmetros de caminho
Corpo
Your merchant account identifier. Validated against the Bearer key's merchant.
Resposta
Cancellation confirmed
A customer enrollment in a plan. plan is embedded on single-subscription responses. Invoice/event history is not included here - use the invoice endpoints.
Subscription UUID.
The merchant account that owns the subscription.
ID of the plan this subscription is enrolled in.
Subscriber email, used for billing and dunning notifications.
Subscriber name as it appears on invoices.
Subscriber national ID / tax document, where a market requires it (e.g. Brazil CPF/CNPJ).
Brand of the card on the mandate, e.g. visa.
pending - awaiting first charge; trialing - in a free trial; active - billing normally; past_due - a renewal failed and dunning is running; suspended - dunning exhausted, needs a new CIT (POST /subscription/{id}/payment-method in CIT mode) to recover; paused - billing stopped on request, resumable; cancelled - terminated; completed - reached maxBillingCycles.
pending, trialing, active, past_due, suspended, paused, cancelled, completed Start of the current billing period.
End of the current billing period.
When the next renewal charge is scheduled.
Trial start, when the plan has a trial.
Trial end - the first real charge date.
Failed-renewal retry attempts made in the current dunning sequence.
When the subscription first became active.
Deferred start, when creation set a future startAt.
Number of billing cycles charged so far.
When the subscription reached maxBillingCycles.
Parent subscription UUID, for add-on hierarchies.
Whether pause/cancel on the parent cascades to this subscription.
Plan the subscription will switch to at the next cycle, set by a next_billing change-plan.
A reusable billing plan. amount is a flat integer in the currency minor units (with separate currency + exponent) - not an Amount object.