Skip to main content
GET
/
subscriptions
List subscriptions
curl --request GET \
  --url https://apiv2.example.com/subscriptions \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "subscriptionId": "<string>",
      "type": "<string>",
      "display": "<string>",
      "msisdn": "<string>",
      "customer": {
        "customerId": "<string>",
        "name": "<string>"
      },
      "sim": {
        "esim": true,
        "imei": "<string>",
        "iccid": "<string>"
      },
      "activatedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "referenceId": "crm-subscription-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"
        }
      },
      "subscriber": {
        "subscriberId": "<string>",
        "name": "<string>",
        "email": "jsmith@example.com",
        "address": {
          "street1": "500 S Main St",
          "city": "Natick",
          "zip": "01701",
          "country": "US",
          "street2": "Apt 1",
          "state": "CA",
          "region": "<string>",
          "attention": "<string>"
        },
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "extensions": {},
      "pendingMsisdn": {
        "msisdn": "<string>",
        "scheduledAt": "2023-12-25"
      },
      "pendingStatus": {
        "scheduledAt": "2023-12-25"
      },
      "pendingProductOffering": {
        "scheduledAt": "2023-12-25",
        "product": {
          "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"
          }
        }
      },
      "porting": {
        "msisdn": "<string>",
        "scheduledAt": "2023-12-25"
      },
      "cancelledAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "pagination": {
    "nextCursor": "<string>"
  }
}

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.

Query Parameters

​
customerId
string[]

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

​
status
enum<string>[]

The status of the subscription to filter by.

The status of the subscription.

Available options:
PENDING,
ACTIVATED,
BLOCKED,
CANCELLED,
PAUSED
​
type
string[]

The type of subscription, categorizing the service into various telecommunications service types.

​
limit
integer
default:100

The maximum number of items to return.

Required range: 1 <= x <= 1000
​
cursor
string

Opaque pagination token from a previous response's nextCursor.

Response

A list of subscriptions.

​
items
object[]
required
​
pagination
object
required