Skip to main content
GET
/
subscriptions
/
{subscriptionId}
/
addons
List active add-ons for subscription
curl --request GET \
  --url https://apiv2.example.com/subscriptions/{subscriptionId}/addons \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "subscriptionAddonId": "<string>",
      "subscriptionId": "<string>",
      "referenceId": "telna-package-12345",
      "productOffering": {
        "productOfferingId": "<string>",
        "name": "<string>",
        "price": {
          "currency": "USD",
          "discount": 5,
          "netPrice": 5,
          "boundMonths": 12,
          "billingCycle": {
            "interval": 1
          },
          "currencyOptions": {}
        },
        "group": {
          "productOfferingGroupId": "mobile-plans",
          "name": "Mobile Plans",
          "category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
          "description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
          "internalDescription": "Core mobile offerings targeting consumer and business segments"
        }
      },
      "group": {
        "productOfferingGroupId": "mobile-plans",
        "name": "Mobile Plans",
        "category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
        "description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
        "internalDescription": "Core mobile offerings targeting consumer and business segments"
      },
      "license": {
        "licenseId": "b3c4d5e6-f7a8-9012-3456-789012345678",
        "productOffering": {
          "productOfferingId": "<string>",
          "name": "<string>",
          "price": {
            "currency": "USD",
            "discount": 5,
            "netPrice": 5,
            "boundMonths": 12,
            "billingCycle": {
              "interval": 1
            },
            "currencyOptions": {}
          },
          "group": {
            "productOfferingGroupId": "mobile-plans",
            "name": "Mobile Plans",
            "category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
            "description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
            "internalDescription": "Core mobile offerings targeting consumer and business segments"
          }
        },
        "assignedTo": {
          "subscriptionId": "<string>",
          "subscriptionDisplay": "<string>"
        },
        "type": "<string>",
        "customer": {
          "customerId": "<string>",
          "name": "<string>"
        },
        "activatedAt": "2024-01-15T10:30:00Z"
      },
      "pendingStatus": {
        "scheduledAt": "2023-12-25"
      },
      "pendingProductOffering": {
        "productOffering": {
          "productOfferingId": "<string>",
          "name": "<string>",
          "price": {
            "currency": "USD",
            "discount": 5,
            "netPrice": 5,
            "boundMonths": 12,
            "billingCycle": {
              "interval": 1
            },
            "currencyOptions": {}
          },
          "group": {
            "productOfferingGroupId": "mobile-plans",
            "name": "Mobile Plans",
            "category": "PRODUCT_CATEGORY_SUBSCRIPTION_CELL",
            "description": "Bundled cell subscriptions with unlimited calls and SMS with ILD enabled.",
            "internalDescription": "Core mobile offerings targeting consumer and business segments"
          }
        },
        "scheduledAt": "2023-12-25"
      },
      "addedAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "cancelledAt": "2023-11-07T05:31:56Z",
      "expiredAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ]
}

Authorizations

​
X-Api-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Path Parameters

​
subscriptionId
string
required

The identifier of the subscription. May be the entity's internal UUID or an external reference identifier. Reference identifiers MUST be prefixed with rid_ (e.g., rid_crm-subscription-12345) so the API can distinguish them from internal UUIDs. The prefix is stripped before lookup.

Query Parameters

​
status
enum<string>[]

Filter add-ons by status.

The status of an add-on on a subscription.

  • PENDING: Add-on is scheduled but not yet active
  • ACTIVE: Add-on is currently active and billable
  • CANCELLED: Add-on has been cancelled and is no longer active
  • EXPIRED: Add-on has expired and is no longer active
Available options:
PENDING,
ACTIVE,
CANCELLED,
EXPIRED

Response

Active add-ons for the subscription.

​
items
object[]
required