Schedule subscription cancellation

Schedule a subscription to be canceled at the end of the current billing period. Only available for Stripe, Paddle, Solidgate, Primer and Zotlo subscriptions.

put/subscription/schedule-cancellation

Request body

pay_system_idstring required

ID of the subscription in external Stripe/Paddle/PayPal, e.g. sub_1PzNJzCsRq5tBi2bbfNsAf86or I-H7HC902MYM49

cancel_at_period_endboolean

If true, the subscription will be scheduled to cancel at the end of the current billing period. If false, the cancellation schedule will be removed.

Example request

{
  "cancel_at_period_end": true
}

Response

Subscription cancellation scheduled successfully.

successinteger

errorinteger

messagestring

Example response

{
  "success": 1,
  "message": "Subscription has been scheduled to cancel at the end of the current billing period"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.