Preview the effects of a subscription plan change before committing to it. Returns the immediate charge amount and the new subscription details without making any actual changes.
| Field | Description |
|---|---|
immediate_charge | The charge that would be created immediately, including line items and summary |
new_plan | The full subscription object showing how it would look after the plan change |
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Subscription Id
Unique identifier of the product to subscribe to
Proration Billing Mode
prorated_immediately, full_immediately, difference_immediately Number of units to subscribe for. Must be at least 1.
x >= 0Addons for the new plan. Note : Leaving this empty would remove any existing addons