Update a subscription

PATCH {{baseUrl}}/subscriptions/:subscription_id

Updates a subscription using its ID.

When making changes to items or the next billing date for a subscription, you must include the proration_billing_mode field to tell Paddle how to bill for those changes.

Send the complete list of items that you'd like to be on a subscription — including existing items. If you omit items, they're removed from the subscription.

For each item, send price_id and quantity. Paddle responds with the full price object for each price. If you're updating an existing item, you can omit the quantity if you don't want to update it.

If successful, your response includes a copy of the updated subscription entity. When an update results in an immediate charge, responses may take longer than usual while a payment attempt is processed.

Request Body

{"customer_id"=>"<string>", "address_id"=>"<string>", "business_id"=>"<string>", "currency_code"=>"<string>", "next_billed_at"=>"<dateTime>", "discount"=>{"id"=>"<string>", "effective_from"=>"<string>"}, "collection_mode"=>"automatic", "billing_details"=>{"enable_checkout"=>false, "purchase_order_number"=>"<string>", "additional_information"=>"<string,null>", "payment_terms"=>{"interval"=>"<string>", "frequency"=>"<integer>"}}, "scheduled_change"=>"<null>", "items"=>[{"price_id"=>"<string>", "quantity"=>"<number>"}], "custom_data"=>"<object>", "proration_billing_mode"=>"<string>", "on_payment_failure"=>"prevent_change"}

HEADERS