Allow users to preview changes to their subscriptions.
Users can preview plan changes, interval changes, next charge date, and new pro-rated amounts. This API allows you to preview the full impact of a plan change before it is committed.
Note: a negative value for
immediate_payment.amount represents a credit balance for the subscriber. This credit amount will automatically be used to deduct the subscriber’s following payments until it is depleted.
The vendor ID identifies your seller account. This can be found in Developer Tools > Authentication.
The vendor auth code is a private API key for authenticating API requests. This key should never be used in client side code or shared publicly. This can be found in Developer Tools > Authentication.
The ID of the subscription to update
The new number of seats after the proposed update
Whether the difference in plan price is billed immediately
Whether the difference in plan price is prorated over the remaining days in the billing cycle
The proposed plan to move the subscription to
Optional, but required if setting
recurring_price. The currency that the recurring price should be charged in. E.g.
EUR, etc. This must be the same as the currency of the existing subscription.
New recurring price per seat to apply to a quantity-enabled subscription
Retain existing modifiers on the user subscription
An unsuccessful call to the Dashboard API will return a 200 response containing a field
success set to
false and an error object.