OpenMeter Product Catalog

Update plan

Changed on

Update a plan by id.

put/openmeter/plans/{planId}

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/plans/{planId}
  • Auth: none declared

Path parameters

planIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Request body

namestring required

Display name of the resource.

Between 1 and 256 characters.

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

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 "_".

pro_rating_enabledboolean

Whether pro-rating is enabled for this plan.

settlement_mode'credit_then_invoice' | 'credit_only'

Settlement mode for billing.

Values:

  • credit_then_invoice: Credits are applied first, then any remainder is invoiced.
  • credit_only: Usage is settled exclusively against credits.

Response

Plan upsert response.

idstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

namestring required

Display name of the resource.

Between 1 and 256 characters.

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

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 "_".

created_atstring date-time required

RFC3339 formatted date-time string in UTC.

updated_atstring date-time required

RFC3339 formatted date-time string in UTC.

deleted_atstring date-time

RFC3339 formatted date-time string in UTC.

keystring required

A key is a unique string that is used to identify a resource.

versioninteger required

Plans are versioned to allow you to make changes without affecting running subscriptions.

billing_cadencestring ISO8601 required

ISO 8601 Duration string.

pro_rating_enabledboolean

Whether pro-rating is enabled for this plan.

effective_fromstring date-time

RFC3339 formatted date-time string in UTC.

effective_tostring date-time

RFC3339 formatted date-time string in UTC.

status'draft' | 'active' | 'archived' | 'scheduled' required

The status of a plan.

  • draft: The plan has not yet been published and can be edited.
  • active: The plan is published and can be used in subscriptions.
  • archived: The plan is no longer available for use.
  • scheduled: The plan is scheduled to be published at a future date.
settlement_mode'credit_then_invoice' | 'credit_only' required

Settlement mode for billing.

Values:

  • credit_then_invoice: Credits are applied first, then any remainder is invoiced.
  • credit_only: Usage is settled exclusively against credits.

Changes

  • v3159bfd1e78cfRevision 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

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

  • v3c3b19585f1baRevision changes
    • info

      added the new optional request property

    • info

      the response property became required for the status

    • info

      the response's property default value credit_then_invoice was removed for the status