PApaddlehq
Subscriptions

Pause a subscription

Changed on

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.

You can pause subscriptions that are past_due, but you can't set on_resume to continue_existing_billing_period for them.

post/subscriptions/{subscription_id}/pause

Request

  • Base URL
    https://sandbox-api.paddle.com
  • Auth
    HTTP bearer

Path parameters

subscription_idstring required

Paddle ID of the subscription entity to work with.

Request body

effective_from'next_billing_period' | 'immediately'

When this subscription change should take effect from. Defaults to next_billing_period, which creates a scheduled_change to apply the subscription change at the end of the billing period.

resume_atstring date-time

RFC 3339 datetime string.

on_resume'continue_existing_billing_period' | 'start_new_billing_period'

How Paddle should set the billing period for the subscription when resuming. If omitted, defaults to start_new_billing_period.

Example request

{
  "resume_at": "2024-10-12T07:20:50.52Z"
}

Response

The request has succeeded.

Changes

  • v14f35a8c6ea4dRevision changes
    • breaking

      added to the ////////// response property oneOf list for the response status

    • breaking

      added to the //////// response property oneOf list for the response status

    • info

      added the required property /// to the response with the status

  • v1e1ac347eb3c5Revision changes
    • warning

      added the new CLP enum value to the // response property for the response status

    • warning

      added the new CLP enum value to the /////// response property for the response status

    • warning

      added the new CLP enum value to the ///////// response property for the response status

    • warning

      added the new PEN enum value to the // response property for the response status

    • warning

      added the new PEN enum value to the /////// response property for the response status

    • warning

      added the new PEN enum value to the ///////// response property for the response status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added to the / response property anyOf list for the response status

    • info

      removed from the / response property anyOf list for the response status

    • info

      added the required property / to the response with the status