Skip to main content
POST
change a customer's active plan

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The plan change request

customerId
string
required

The Unprice customer whose active subscription will change

Example:

"cus_1234567890"

planVersionId
string
required

The published target plan version

Example:

"pv_1234567890"

creditLinePolicy
enum<string>

Usage credit policy for the replacement phase. Required when creditLineAmountMinor is provided.

Available options:
capped,
uncapped
Example:

"capped"

creditLineAmountMinor
integer | null

Optional replacement-phase credit cap in currency minor units. For USD/EUR, 1000 means $10.00.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1000

Response

The plan change result

status
enum<string>
required
Available options:
changed
subscriptionId
string
required
phaseId
string
required