OpenMeter Product Catalog

List add-ons for plan

Changed on

List add-ons associated with a plan.

get/openmeter/plans/{planId}/addons

Request

  • Base URL: http://localhost:8888/api/v3
  • URL: http://localhost:8888/api/v3/openmeter/plans/{planId}/addons
  • Auth: none declared

Path parameters

planIdstring 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 plan add-ons returned in the response. Supported sort attributes are:

  • id (default)
  • created_at
  • updated_at

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

Filter plan add-ons returned in the response.

{
  "id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "addon_id": "01G65Z755AFWAKHE12NY0CQ9FH"
}

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"
      },
      "from_plan_phase": "resource_key",
      "validation_errors": [
        {
          "field": "addons/pro/ratecards/token/featureKey"
        }
      ]
    }
  ],
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  }
}

Changes

  • v3a71813646215Revision changes
    • info

      added the new optional query request parameter filter

    • info

      added the new optional query request parameter sort

  • v33be06f269447Revision changes
    • info

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

    • info

      removed from the // response property allOf list for the response status