post

/2.0/subscription/preview_update

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.

Request Body

Form data (application/x-www-form-urlencoded)

vendor_id

integer

The vendor ID identifies your seller account. This can be found in Developer Tools > Authentication.

required

minimum: 1

pattern: \d+

vendor_auth_code

string

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.

required

pattern: [0-9a-f]+

subscription_id

integer

The ID of the subscription to update

required

quantity

integer

The new number of seats after the proposed update

bill_immediately

boolean

Whether the difference in plan price is billed immediately

default: false

prorate

boolean

Whether the difference in plan price is prorated over the remaining days in the billing cycle

default: true

plan_id

integer

The proposed plan to move the subscription to

currency

string

Optional, but required if setting recurring_price. The currency that the recurring price should be charged in. E.g. USD, GBP, EUR, etc. This must be the same as the currency of the existing subscription.

pattern: [A-Z]{3}

recurring_price

number

New recurring price per seat to apply to a quantity-enabled subscription

keep_modifiers

boolean

Retain existing modifiers on the user subscription

default: true

Responses

1 Example

Schema

object

An unsuccessful call to the Dashboard API will return a 200 response containing a field success set to false and an error object.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)

$$.env

No $$.env variables are being used in this request.