Skip to main content
POST
Cancel a Subscription
The body is optional. Omit it (or send {}) to default reason to user_requested. Card subscriptions. Cancellation is scheduled at the end of the current period — cancelAtPeriodEnd becomes true immediately, and the subscription transitions to canceled when the period ends. A subscription.updated webhook is dispatched on each cancel call. Pix Automático subscriptions. Cancellation is immediate and is never scheduled for the end of the period. The response is either already canceled, or keeps the current status with recurringAuthorization.status: "cancel_pending" until the cancellation is confirmed. The webhook is subscription.canceled, not subscription.updated. See Pix Automático Subscriptions.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

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)$

Body

application/json
reason
enum<string>
default:user_requested
Available options:
user_requested,
payment_failure,
chargeback,
system

Response

Success

success
boolean
required
requestId
string
required
data
object
required