Sign in
Product Catalog

List add-ons

List all add-ons.

get/api/v1/addons

Query parameters

includeDeletedboolean

Include deleted add-ons in response.

Usage: ?includeDeleted=true

idstring[]

Filter by addon.id attribute

[
  "01G65Z755AFWAKHE12NY0CQ9FH"
]
keystring[]

Filter by addon.key attribute

keyVersionobject

Filter by addon.key and addon.version attributes

statusAddonStatus[]

Only return add-ons with the given status.

Usage:

  • ?status=active: return only the currently active add-ons
  • ?status=draft: return only the draft add-ons
  • ?status=archived: return only the archived add-ons
currencyCurrencyCode[]

Filter by addon.currency attribute

[
  "USD"
]
pageinteger

Page index.

Default is 1.

pageSizeinteger

The maximum number of items per page.

Default is 100.

order'ASC' | 'DESC'

The order direction.

The order direction.

orderBy'id' | 'key' | 'version' | 'created_at' | 'updated_at'

Order by options for add-ons.

The order by field.

Response

The request has succeeded.

pageinteger required

The page index.

pageSizeinteger required

The maximum number of items per page.

totalCountinteger required

The total number of items.

Example response

{
  "items": [
    {
      "annotations": {
        "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
      },
      "createdAt": "2024-01-01T01:01:01.001Z",
      "currency": "USD",
      "deletedAt": "2024-01-01T01:01:01.001Z",
      "effectiveFrom": "2023-01-01T01:01:01.001Z",
      "effectiveTo": "2023-01-01T01:01:01.001Z",
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "metadata": {
        "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
      },
      "rateCards": [
        {
          "discounts": {
            "percentage": {
              "percentage": 50
            }
          },
          "entitlementTemplate": {
            "metadata": {
              "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
            }
          },
          "metadata": {
            "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
          },
          "taxConfig": {
            "stripe": {
              "code": "txcd_10000000"
            },
            "taxCodeId": "01G65Z755AFWAKHE12NY0CQ9FH"
          }
        }
      ],
      "updatedAt": "2024-01-01T01:01:01.001Z",
      "validationErrors": [
        {
          "attributes": {
            "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
          },
          "code": "invalid_feature_key",
          "field": "addons/pro/ratecards/token/featureKey",
          "message": "not found feature by key"
        }
      ]
    }
  ],
  "page": 1,
  "pageSize": 100,
  "totalCount": 500
}

Changes