Subscriptions

Migrate subscription to latest plan version

Migrates a subscription to the latest published version of its plan or add-ons. Handles prorated charges or credits automatically.

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

Path parameters

idstring required

The unique identifier of the entity

Request body

subscriptionMigrationTime'END_OF_BILLING_PERIOD' | 'IMMEDIATE'

When to migrate (immediate or period end)

Response

The migrated subscription object.

Changes