Sign in
OpenMeter Subscriptions

Migrate subscription

Changed on

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/openmeter/subscriptions/{subscriptionId}/migrate

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/subscriptions/{subscriptionId}/migrate
  • Auth: none declared

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

RFC3339 formatted date-time string in UTC.

Example request

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

Response

The request has succeeded.

Changes

  • v3159bfd1e78cfRevision changes
    • ○

      added to the ////////////// response property allOf list for the response status

    • ○

      removed from the ////////////// response property allOf list for the response status

  • v397d19f496741Revision changes
    • ○

      endpoint added