Sign in
OpenMeter Subscriptions

Update subscription addon

Changed on

Update a subscription add-on. Only the quantity is mutable; the timing controls when the new quantity takes effect. A new entry is appended to the add-on's timeline.

patch/openmeter/subscriptions/{subscriptionId}/addons/{subscriptionAddonId}

Request

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

Path parameters

subscriptionIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH
subscriptionAddonIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Request body

quantityinteger required

The new quantity of the add-on. Must be at least 0. A quantity of 0 removes the add-on from the point the timing resolves to.

Example request

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

Response

SubscriptionAddon updated response.

idstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

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.

namestring required

Display name of the resource.

Between 1 and 256 characters.

descriptionstring

Optional description of the resource.

Maximum 1024 characters.

quantityinteger required

The quantity of the add-on. Always 1 for single instance add-ons.

quantity_atstring date-time required

RFC3339 formatted date-time string in UTC.

active_fromstring date-time required

RFC3339 formatted date-time string in UTC.

active_tostring date-time

RFC3339 formatted date-time string in UTC.

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

  • v3c86a4709f542Revision changes
    • ○

      endpoint added