Update User

post

/2.0/subscription/users/update

Update the quantity, price, and/or plan of a user's subscription

Example Request

preparing...

Usage Notes

Subscribers on non-quantity plans can move to quantity plans but not the inverse.
Subscribers must be billed immediately when moving to a plan with a different billing interval.
Subscribers cannot be moved to a plan where the current currency is not enabled.
Subscribers cannot update or change their plan while in a trialing state.
Subscribers in a paused state cannot be modified until they restart their subscription.
Subscribers in a past due state can only have the passthrough or pause field updated.
The currency of an existing subscription cannot be changed.
Recurring coupons (if present) will be removed when this API is used.
If the subscriber is to be billed US$0.70 or less (or the equivalent currency amount), this will not be charged during the subscription update and will be added onto the next scheduled payment amount.

Request

Body

vendor_id

integer

required

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

>= 1

vendor_auth_code

string

required

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.

Match pattern:

[0-9a-f]+

subscription_id

integer

required

The ID of the subscription you’re updating.

quantity

integer

The new quantity to be applied to the subscription.Show all...

>= 1<= 10000

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.

Match pattern:

[A-Z]{3}

recurring_price

number

The new recurring price per quantity unit to apply to the subscription. Please note this is a singular price, i.e 11.00.

plan_id

integer

The new plan ID to move the subscription to.

prorate

boolean

Whether the change in subscription should be prorated.

Default:

true

bill_immediately

boolean

If the subscription should bill for the next interval at the revised figures immediately.

Default:

false

keep_modifiers

boolean

Retain the existing modifiers on the user subscription.

Default:

true

passthrough

string

Update the additional data associated with this subscription, like additional features, add-ons and seats. This will be included in all subsequent webhooks, and is often a JSON string of relevant data.

<= 1000 characters

pause

boolean

Pause or restart a subscription. If the subscription is not paused and this is set to true, the subscription status will be changed to "paused" when the subscription's next scheduled payment date is reached.Show all...

Default:

false

Body