Cancel a subscription
Cancels a subscription. The upstream recurring billing (card/Inflow) is always cancelled immediately so the customer is never charged again.
Default behaviour — access removal depends on the remaining paid period:
- Paid period still running (
ACTIVEwith a futureexpiresAt) — the cancellation is scheduled. The subscription staysACTIVEwithcancelAtPeriodEnd: true, the customer keeps access untilcurrentPeriodEnd(expiresAt), then it moves toINACTIVE. - Lifetime access (no
expiresAt) or already-expired paid period — the subscription is cancelled immediately (status: CANCELLED) and access is revoked right away.
Immediate cancellation — set immediate: true (request body) or ?immediate=true (query string)
to force an instant cancellation even when a paid period is still running: the subscription goes
straight to CANCELLED, platform access (Discord/Telegram) is revoked right away, and the customer
loses access immediately (no proration/refund is issued).
Calling this on a subscription that is already CANCELLED or already scheduled to cancel
(cancelAtPeriodEnd: true) returns a 400.
Authorizations
API key authentication
Path Parameters
Query Parameters
Set to true to cancel immediately and revoke access now instead of scheduling for period end.
Body
When true, cancels immediately and revokes access now (status: CANCELLED,
cancelAtPeriodEnd: false) instead of scheduling the cancellation for the end of the
current paid period. Can also be passed as the ?immediate=true query parameter.
true

