STstiggio
Subscriptions

Migrate subscription to latest plan version

Changed on

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

Request

  • Base URL
    https://api.stigg.io
  • URL
    https://api.stigg.io/api/v1/subscriptions/{id}/migrate
  • Auth
    API key in header X-API-KEY

Path parameters

idstring required

The unique identifier of the entity

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Request body

subscriptionMigrationTime'END_OF_BILLING_PERIOD' | 'IMMEDIATE'

When to migrate (immediate or period end)

Response

The migrated subscription object.

Changes

  • 913f273cc2f7Revision changes
    • warning

      added the new ContractNotFound enum value to the response property for the response status

    • info

      added the optional property / to the response with the status

  • b876edd1a4fcRevision changes
    • warning

      added the new CreditOveragePriceCurrencyNotFound enum value to the response property for the response status

    • warning

      added the new InvalidCreditOverageBillingModel enum value to the response property for the response status

    • warning

      added the new InvoicePreviewNotAvailableForDraftContract enum value to the response property for the response status

    • warning

      added the new OveragePriceNotSupportedOnAddon enum value to the response property for the response status

    • warning

      added the new OveragePriceRequiresUsageLimit enum value to the response property for the response status