Sign in
OpenMeter Subscriptions

Get add-on association for subscription

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

Get an add-on association for a subscription.

get/v3/openmeter/subscriptions/{subscriptionId}/addons/{subscriptionAddonId}

Path parameters

subscriptionIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH
subscriptionAddonIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

SubscriptionAddon 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

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity last update date.

deleted_atstring date-time

An ISO-8601 timestamp representation of entity deletion date.

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

An ISO-8601 timestamp representation of which point in time the quantity was resolved to.

active_fromstring date-time required

An ISO-8601 timestamp representation of the cadence start of the resource.

active_tostring date-time

An ISO-8601 timestamp representation of the cadence end of the resource.

Example response

{
  "id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "labels": {
    "env": "test"
  },
  "created_at": "2023-01-01T01:01:01.001Z",
  "updated_at": "2023-01-01T01:01:01.001Z",
  "deleted_at": "2023-01-01T01:01:01.001Z",
  "addon": {
    "id": "01G65Z755AFWAKHE12NY0CQ9FH"
  },
  "quantity_at": "2023-01-01T01:01:01.001Z",
  "active_from": "2023-01-01T01:01:01.001Z",
  "active_to": "2023-01-01T01:01:01.001Z",
  "timeline": [
    {
      "quantity": 1,
      "active_from": "2025-01-01T00:00:00Z",
      "active_to": "2025-01-02T00:00:00Z"
    },
    {
      "quantity": 0,
      "active_from": "2025-01-02T00:00:00Z",
      "active_to": "2025-01-03T00:00:00Z"
    },
    {
      "quantity": 1,
      "active_from": "2025-01-03T00:00:00Z"
    }
  ],
  "rate_cards": [
    {
      "rate_card": {
        "labels": {
          "env": "test"
        },
        "key": "resource_key",
        "feature": {
          "id": "01G65Z755AFWAKHE12NY0CQ9FH"
        },
        "billing_cadence": "P1Y",
        "tax_config": {
          "code": {
            "id": "01G65Z755AFWAKHE12NY0CQ9FH"
          }
        },
        "entitlement": {
          "usage_period": "P1Y"
        }
      },
      "affected_subscription_item_ids": [
        "01G65Z755AFWAKHE12NY0CQ9FH"
      ]
    }
  ]
}

Changes

Changed in 2 of the 75 revisions of this API.5

  • a2e95e9f6c804See the full diff
    • ○

      the response optional property description became read-only for the status 200

      response-optional-property-became-read-only

    • ○

      added the required property rate_cards to the response with the 200 status

      response-required-property-added

    • ○

      added the required property timeline to the response with the 200 status

      response-required-property-added

    • ○

      the response required property name became read-only for the status 200

      response-required-property-became-read-only

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c83332d134eb1See the full diff
    • ○

      endpoint added

      endpoint-added