Sign in
OpenMeter Product Catalog

Get add-on

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

Get add-on by id.

get/v3/openmeter/addons/{addonId}

Path parameters

addonIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

Addon 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

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.

keystring required

A key is a semi-unique string that is used to identify the add-on. It is used to reference the latest active version of the add-on and is unique with the version number.

versioninteger required

Version of the add-on. Incremented when the add-on is updated.

instance_type'single' | 'multiple' required

The InstanceType of the add-ons. Can be "single" or "multiple".

currencystring required

Fiat or custom currency code.

effective_fromstring date-time

The date and time when the add-on becomes effective. When not specified, the add-on is a draft.

effective_tostring date-time

The date and time when the add-on is no longer effective. When not specified, the add-on is effective indefinitely.

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

The status of the add-on. Computed based on the effective start and end dates:

  • draft: effective_from is not set.
  • active: effective_from <= now and (effective_to is not set or now < effective_to).
  • archived: effective_to <= now.

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",
  "key": "resource_key",
  "currency": "USD",
  "effective_from": "2023-01-01T01:01:01.001Z",
  "effective_to": "2023-01-01T01:01:01.001Z",
  "rate_cards": [
    {
      "labels": {
        "env": "test"
      },
      "key": "resource_key",
      "feature": {
        "id": "01G65Z755AFWAKHE12NY0CQ9FH"
      },
      "billing_cadence": "P1Y",
      "tax_config": {
        "code": {
          "id": "01G65Z755AFWAKHE12NY0CQ9FH"
        }
      },
      "entitlement": {
        "usage_period": "P1Y"
      }
    }
  ],
  "validation_errors": [
    {
      "field": "addons/pro/ratecards/token/featureKey"
    }
  ]
}

Changes

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

  • a2e95e9f6c803See the full diff
    • ○

      api operation id get-openmeter-addon removed and replaced with get-product-catalog-addon

      api-operation-id-removed

    • ○

      added the optional property rate_cards/items/entitlement to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property rate_cards/items/unit_config to the response with the 200 status

      response-optional-property-added

    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