Preview an update to a subscription

PATCH {{baseUrl}}/subscriptions/:subscription_id/preview

Previews an update for a subscription without applying those changes. Typically used for previewing proration before making changes to a subscription.

If successful, your response includes immediate_transaction, next_transaction, and recurring_transaction_details so you can see expected transactions for the changes.

The update_summary object contains details of prorated credits and charges created, along with the overall result of the update.

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