Sign in
OpenMeter Subscriptions

List subscription addons

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

List the add-ons of a subscription.

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

Path parameters

subscriptionIdstring required

ULID (Universally Unique Lexicographically Sortable Identifier).

Example:01G65Z755AFWAKHE12NY0CQ9FH

Query parameters

sizeinteger

The number of items to include per page.

numberinteger

The page number.

Determines which page of the collection to retrieve.

sortstring

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provided via a comma separated list. JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar desc').

Example:created_at desc

Sort subscription addons returned in the response. Supported sort attributes are:

  • id
  • created_at (default)
  • updated_at

The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order.

Response

Page paginated response.

Example response

{
  "data": [
    {
      "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"
          ]
        }
      ]
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

Changes

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

  • a2e95e9f6c804See the full diff
    • ○

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

      response-optional-property-became-read-only

    • ○

      added the required property data/items/rate_cards to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/timeline to the response with the 200 status

      response-required-property-added

    • ○

      the response required property data/items/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