Skip to main content
DELETE
Cancel a subscription

Authorizations

X-Suby-Api-Key
string
header
required

API key authentication

Path Parameters

subscriptionId
string
required

Query Parameters

immediate
boolean
default:false

Set to true to cancel immediately and revoke access now instead of scheduling for period end.

Body

application/json
immediate
boolean
default:false

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.

Example:

true

Response

Subscription cancelled

success
boolean
Example:

true

data
object