PApaddlehq
Subscriptions

Cancel a subscription

Changed on

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. Paused subscriptions can only be canceled immediately, so you must set effective_from to immediately to cancel them.

You can cancel subscriptions that are past_due. If you cancel at the end of the billing period, the status remains past_due until the end of the current billing period. Cancel immediately to stop the subscription right away.

You can't reinstate a canceled subscription.

post/subscriptions/{subscription_id}/cancel

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.

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