OpenMeter Subscriptions

Change subscription

Closes a running subscription and starts a new one according to the specification. Can be used for upgrades, downgrades, and plan changes.

post/openmeter/subscriptions/{subscriptionId}/change

Request

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

subscriptionIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

labelsLabels

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

settlement_mode'credit_then_invoice' | 'credit_only'

Settlement mode for billing.

Values:

starting_phasestring

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

Only applies when creating from a published plan; custom plans define their own phases inline.

billing_anchorstring date-time

RFC3339 formatted date-time string in UTC.

cost_basis_mode'dynamic' | 'pinned'

Controls how custom-currency cost bases are selected for the subscription.

The request has succeeded.

Sep 21, 2026v3159bfd1e78cf Revision changes
- breaking
  added to the ///////// request property allOf list
- warning
  removed from the ///////// request property allOf list
- info
  added to the ////////////// response property allOf list for the response status
- info
  added to the ////////////// response property allOf list for the response status
- info
  removed from the ////////////// response property allOf list for the response status
- info
  removed from the ////////////// response property allOf list for the response status
Sep 10, 2026v3c86a4709f542 Revision changes
- info
  added the new optional request property