Skip to main content
Cancels a subscription. By default the cancellation is immediate; with at_period_end: true the customer keeps what they paid for and no further charge is made once the current period ends.

Path Parameters

string
required
The subscription to cancel.

Body

boolean
default:"false"
false cancels now: the subscription becomes canceled at once and, if the first charge was still unpaid, the checkout can no longer be paid. true only flags the subscription (cancel_at_period_end: true); it stays active until current_period_end, then is canceled instead of renewed. Allowed only on active or past_due subscriptions.
The result object is the full subscription, as on Get Subscription — the examples above are abridged.

Errors

You receive subscription.canceled for an immediate cancel and subscription.updated when a period-end cancel is scheduled — see Webhooks. The customer is notified in the Flouci app in both cases.