Sign in

v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB
Subscriptions

List subscription addons

List all addons of a subscription. In the returned list will match to a set unique by addonId.

get/api/v1/subscriptions/{subscriptionId}/addons

Path parameters

subscriptionIdstring required
Example:01G65Z755AFWAKHE12NY0CQ9FH

Response

The request has succeeded.

idstring required

A unique identifier for the resource.

namestring required

Human-readable name for the resource. Between 1 and 256 characters.

descriptionstring

Optional description of the resource. Maximum 1024 characters.

metadataMetadata

Set of key-value pairs. Metadata can be used to store additional information about a resource.

createdAtstring date-time required

Timestamp of when the resource was created.

updatedAtstring date-time required

Timestamp of when the resource was last updated.

deletedAtstring date-time

Timestamp of when the resource was permanently deleted.

activeFromstring date-time required

The cadence start of the resource.

activeTostring date-time

The cadence end of the resource.

quantityAtstring date-time required

For which point in time the quantity was resolved to.

quantityinteger required

The quantity of the add-on. Always 1 for single instance add-ons.

subscriptionIdstring required

The ID of the subscription.

Example response

[
  {
    "id": "01G65Z755AFWAKHE12NY0CQ9FH",
    "metadata": {
      "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
    },
    "createdAt": "2024-01-01T01:01:01.001Z",
    "updatedAt": "2024-01-01T01:01:01.001Z",
    "deletedAt": "2024-01-01T01:01:01.001Z",
    "activeFrom": "2023-01-01T01:01:01.001Z",
    "activeTo": "2023-01-01T01:01:01.001Z",
    "addon": {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH"
    },
    "quantityAt": "2025-01-05T00:00:00Z",
    "quantity": 1,
    "timeline": [
      {
        "quantity": 1,
        "activeFrom": "2025-01-01T00:00:00Z",
        "activeTo": "2025-01-02T00:00:00Z"
      },
      {
        "quantity": 0,
        "activeFrom": "2025-01-02T00:00:00Z",
        "activeTo": "2025-01-03T00:00:00Z"
      },
      {
        "quantity": 1,
        "activeFrom": "2025-01-03T00:00:00Z"
      }
    ],
    "subscriptionId": "01G65Z755AFWAKHE12NY0CQ9FH",
    "rateCards": [
      {
        "rateCard": {
          "metadata": {
            "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
          },
          "entitlementTemplate": {
            "metadata": {
              "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
            }
          },
          "taxConfig": {
            "stripe": {
              "code": "txcd_10000000"
            },
            "taxCodeId": "01G65Z755AFWAKHE12NY0CQ9FH"
          },
          "discounts": {
            "percentage": {
              "percentage": 50
            }
          }
        },
        "affectedSubscriptionItemIds": [
          "01G65Z755AFWAKHE12NY0CQ9FH"
        ]
      }
    ]
  }
]