Subscriptions
Cancel subscription
Cancels a subscription using the supplied cancellation request.
Supported cancellation types:
- PeriodEnd - Cancel subscription at the end of the billing cycle
- Immediate - Cancel subscription immediately
- Date - Cancel at specified ‘CancelAt’ date
If not supplied, PeriodEnd is used and the subscription is cancelled at the end of the billing cycle.
Important considerations:
- If the subscription is trialing a tier, the tier is reverted to the previous tier at the end of the trials duration. This is only supported with PeriodEnd CancellationType.
- If the subscription is trialing an add-on, the add-on is removed at the end of the trials duration. This is only supported with PeriodEnd CancellationType.
PATCH
Path Parameters
The unique identifier of the subscription
Body
Response
200
application/json
Successfully cancelled the subscription
The response is of type object
.