Operations API
Subscriptions

Cancel Subscription

This API endpoint (POST) cancels a subscription. If the request succeeds, it returns a Subscription Object. Permissions: subscriptions.edit Webhook event: subscription-updated

Path Parameters

id * The id of the subscription to cancel.

Body Parameters

cancel_behaviour string * The possible values are immediate (subscription is cancelled instantly) and end_of_period (subscription cancels at the end of the current billing period).