Skip to main content
GET
/
licenses
List licenses
curl --request GET \
  --url https://apiv2.example.com/licenses \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "licenseId": "<string>",
      "status": "PENDING",
      "type": "<string>",
      "customer": {
        "customerId": "<string>",
        "name": "<string>"
      },
      "productOffering": {
        "productOfferingId": "<string>",
        "name": "<string>",
        "price": {
          "currency": "USD",
          "priceType": "ONE_TIME",
          "discount": 5,
          "netPrice": 5,
          "boundMonths": 12,
          "billingCycle": {
            "period": "MONTHLY",
            "interval": 1
          }
        },
        "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"
        }
      },
      "activatedAt": "2023-12-25",
      "assignedTo": {
        "type": "SUBSCRIPTION",
        "subscriptionId": "<string>",
        "subscriptionDisplay": "<string>"
      },
      "details": {},
      "pendingStatus": {
        "status": "PENDING",
        "scheduledAt": "2023-12-25"
      },
      "pendingProductOffering": {
        "scheduledAt": "2023-12-25",
        "product": {
          "productOfferingId": "<string>",
          "name": "<string>",
          "price": {
            "currency": "USD",
            "priceType": "ONE_TIME",
            "discount": 5,
            "netPrice": 5,
            "boundMonths": 12,
            "billingCycle": {
              "period": "MONTHLY",
              "interval": 1
            }
          },
          "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"
          }
        }
      },
      "cancelledAt": "2023-12-25",
      "pausedAt": "2023-12-25",
      "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. Accepts either:

  • Internal UUID (e.g., "a47ac10b-58cc-4372-a567-0e02b2c3d479")
  • External referenceId (e.g., "crm-customer-12345")
​
type
string[]

The type of license to filter by.

The type of license, categorizing the software product or service into various telecommunications license 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 licenses.

​
items
object[]
required
​
pagination
object
required