OpenMeter Subscriptions

Get add-on association for subscription

Changed on

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}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/openmeter/subscriptions/{subscriptionId}/addons/{subscriptionAddonId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

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"
        },
        "currency": "USD",
        "billing_cadence": "P1Y",
        "tax_config": {
          "code": {
            "id": "01G65Z755AFWAKHE12NY0CQ9FH"
          }
        },
        "entitlement": {
          "usage_period": "P1Y"
        }
      },
      "affected_subscription_item_ids": [
        "01G65Z755AFWAKHE12NY0CQ9FH"
      ]
    }
  ]
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

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

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • breaking

      the response property //// became optional for the status

    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status