Cancel a subscription

POST {{baseUrl}}/subscriptions/:subscription_id/cancel

Cancels a subscription using its ID.

By default, active subscriptions are canceled at the end of the billing period. When you send a request to cancel, Paddle creates a scheduled_change against the subscription entity to say that it should cancel at the end of the current billing period. Its status remains active until after the effective date of the scheduled change, at which point it changes to canceled.

You can cancel a subscription right away by including effective_from in your request, setting the value to immediately. If successful, your response includes a copy of the updated subscription entity with the status of canceled. Canceling immediately is the default behavior for paused subscriptions.

You cannot reinstate a canceled subscription.

Request Body

{"effective_from"=>"next_billing_period"}

HEADERS