NodeRings Docs

List Addon Subscriptions

List addon subscriptions for a subscription

GET
/v1/subscriptions/{subscriptionId}/addons
Authorization<token>

Bearer token

In: header

X-Organization-ID<token>

Tenant or organization identifier

In: header

Path Parameters

subscriptionIdstring

Query Parameters

addonStatus?string

Filter by status

Value in"ADDON_STATUS_UNSPECIFIED" | "ADDON_STATUS_ACTIVE" | "ADDON_STATUS_CANCELED" | "ADDON_STATUS_PAUSED" | "ADDON_STATUS_PENDING_ACTIVATION"

Response Body

application/json

curl -X GET "https://api.nrings.io/v1/subscriptions/{subscriptionId}/addons?addonStatus" \  -H "Authorization: Bearer {your_token}" \  -H "X-Organization-ID: {your_org_id}"
{
  "addonSubscriptions": [
    {
      "id": "string",
      "quantity": 0,
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "addonStatus": "ADDON_STATUS_UNSPECIFIED",
      "cancelAtPeriodEnd": true,
      "canceledAt": "2019-08-24T14:15:22Z",
      "externalId": "string",
      "subscriptionId": "string",
      "addonId": "string",
      "addonPriceId": "string",
      "subscriptionName": "string",
      "addonName": "string",
      "addonCode": "string",
      "metadata": {},
      "status": "STATUS_UNSPECIFIED",
      "timestamps": {
        "createTime": "2019-08-24T14:15:22Z",
        "updateTime": "2019-08-24T14:15:22Z"
      }
    }
  ],
  "totalCount": 0
}