Skip to main content
POST
Cancel a Subscription
O corpo é opcional. Omita-o (ou envie {}) para usar o reason padrão user_requested. O cancelamento é agendado para o fim do período atual — cancelAtPeriodEnd passa a true imediatamente, e a assinatura transiciona para canceled quando o período termina. Um webhook subscription.updated é disparado em cada chamada de cancelamento.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

id
string<uuid>
obrigatório

Public subscription id (UUID).

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Corpo

application/json
reason
enum<string>
padrão:user_requested
Opções disponíveis:
user_requested,
payment_failure,
chargeback,
system

Resposta

Success

success
boolean
obrigatório
requestId
string
obrigatório
data
object
obrigatório