Sign in
OpenMeter Subscriptions

Migrate subscription

Changed on

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

Migrates to a later version of the current plan. With starting_phase omitted and billing_anchor omitted or unchanged, migration amends the subscription in place: unchanged items retain their service periods and both response entries have the same ID. Existing addons must remain compatible with the target plan. Incompatible phase timelines or billing settings return an error. Providing starting_phase or a different billing_anchor explicitly requests replacement, which resets the phase timeline, may produce billing adjustments, and does not transfer addons. Custom subscriptions cannot be migrated.

post/v3/openmeter/subscriptions/{subscriptionId}/migrate

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/openmeter/subscriptions/{subscriptionId}/migrate
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

subscriptionIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Request body

target_versioninteger

A strictly later version of the current plan. Omit to use its latest version.

starting_phasestring

Explicitly replace the subscription, starting in this target plan phase. Always selects replacement, even when the phase matches the current one. Replacement may produce billing adjustments and does not transfer addons.

billing_anchorstring date-time

Providing a different billing anchor explicitly replaces the subscription. The supplied anchor is preserved and may be before or after the replacement's start time. Omit to retain the existing anchor.

Example request

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

Response

The request has succeeded.

Changes