Skip to main content
POST
Migrate To A Plan Version

Authorizations

Authorization
string
header
required

API key authentication

Path Parameters

id
string
required

The subscription ID

Body

application/json

The plan version to move the subscription to.

targetVersionNumber
integer
required

The number of a published version of the subscription's plan.

Required range: 1 <= x <= 2147483647
timing
enum<string>

When the migration takes effect. next_period moves everything at the end of the current billing period. immediate changes entitlements at once, bills in-arrears prices for the whole current period at the target version, and changes in-advance prices at the end of the current period. Neither prorates. If absent, the plan's versionTransition applies.

Available options:
next_period,
immediate

Response

The subscription after the migration, and what the migration did. If changed is false, nothing moved.

subscription
object
required
migration
object
required
lineItems
object
required