Skip to main content
GET
/
licenses
/
{licenseId}
{
  "licenseId": "<string>",
  "status": "PENDING",
  "type": "<string>",
  "customerId": "<string>",
  "customer": {
    "customerId": "<string>",
    "name": "<string>"
  },
  "productOfferingId": "<string>",
  "productOffering": {
    "productOfferingId": "<string>",
    "name": "<string>",
    "price": {
      "grossPrice": 10,
      "discount": 123,
      "netPrice": 5,
      "currency": "USD",
      "priceType": "ONE_TIME",
      "boundMonths": 12,
      "billingCycle": {
        "period": "MONTHLY",
        "interval": 1
      },
      "taxIncluded": true
    },
    "productOfferingGroupId": "<string>",
    "group": {
      "productOfferingGroupId": "<string>",
      "name": "<string>",
      "category": "SUBSCRIPTION_CELL"
    }
  },
  "assignedTo": {
    "type": "SUBSCRIPTION",
    "subscriptionId": "<string>",
    "subscriptionDisplay": "<string>"
  },
  "details": {},
  "pendingStatus": {
    "status": "PENDING",
    "scheduledAt": "2023-12-25"
  },
  "pendingProductOffering": {
    "scheduledAt": "2023-12-25",
    "productOfferingId": "<string>",
    "name": "<string>",
    "price": {
      "grossPrice": 10,
      "discount": 123,
      "netPrice": 5,
      "currency": "USD",
      "priceType": "ONE_TIME",
      "boundMonths": 12,
      "billingCycle": {
        "period": "MONTHLY",
        "interval": 1
      },
      "taxIncluded": true
    },
    "productOfferingGroupId": "<string>",
    "group": {
      "productOfferingGroupId": "<string>",
      "name": "<string>",
      "category": "SUBSCRIPTION_CELL"
    }
  },
  "activatedAt": "2023-11-07T05:31:56Z",
  "cancelledAt": "2023-11-07T05:31:56Z",
  "pausedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "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

​
licenseId
string
required

The unique identifier of the license.

Response

A license object.

A license represents a permission to use a software product with embedded customer and product offering details.

​
licenseId
string
required

The unique identifier for the license.

​
status
enum<string>
required

The status of the license.

Available options:
PENDING,
ACTIVE,
PAUSED,
CANCELLED,
BLOCKED
​
type
string
required

The type of license, categorizing the software product or service into various telecommunications license types.

​
customer
object
required

Customer information embedded in responses. Sensitive details require separate API calls with appropriate authorization.

​
productOffering
object
required

Embedded representation of a product offering.

​
activatedAt
string<date-time>
required

The date and time when the license was activated.

​
createdAt
string<date-time>
required

The date and time when the license was created.

​
updatedAt
string<date-time>
required

The date and time when the license was last updated.

​
customerId
string

The unique identifier for the customer.

​
productOfferingId
string

The unique identifier for the product offering.

​
assignedTo
object

Assignment details for a license, indicating what entity the license is assigned to. This embedded version includes additional display information for each assignment type.

License assigned to a subscription

​
details
object

Additional license details specific to certain license types.

​
pendingStatus
object

Details about when a pending status change is scheduled for this license.

​
pendingProductOffering
object

Embedded representation of a product offering.

​
cancelledAt
string<date-time>

The date and time when the license was cancelled (if applicable).

​
pausedAt
string<date-time>

The date and time when the license was paused (if applicable).

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

⌘I