Pause a subscription

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

Pauses a subscription using its ID.

By default, subscriptions are paused at the end of the billing period. When you send a request to pause, Paddle creates a scheduled_change against the subscription entity to say that it should pause 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 paused.

You can pause 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 paused.

To set a resume date, include the resume_at field in your request. The subscription remains paused until the resume date, or until you send a resume request. Omit to create an open-ended pause. The subscription remains paused indefinitely, until you send a resume request.

Request Body

{"effective_from"=>"next_billing_period", "resume_at"=>"<dateTime>"}

HEADERS