Sign in

v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB
Subscriptions

Migrate subscription

Migrates the subscripiton to the provided version of the current plan. If possible, the migration will be done immediately. If not, the migration will be scheduled to the end of the current billing period.

post/api/v1/subscriptions/{subscriptionId}/migrate

Path parameters

subscriptionIdstring required
Example:01G65Z755AFWAKHE12NY0CQ9FH

Request body

targetVersioninteger

The version of the plan to migrate to. If not provided, the subscription will migrate to the latest version of the current plan.

startingPhasestring

The key of the phase to start the subscription in. If not provided, the subscription will start in the first phase of the plan.

billingAnchorstring date-time

The billing anchor of the subscription. The provided date will be normalized according to the billing cadence to the nearest recurrence before start time. If not provided, the previous subscription billing anchor will be used.

Example request

{
  "timing": "2023-01-01T01:01:01.001Z",
  "billingAnchor": "2023-01-01T01:01:01.001Z"
}

Response

The request has succeeded.