A valid request URL is required to generate request examples{
"items": [
{
"licenseId": "<string>",
"status": "PENDING",
"type": "<string>",
"customer": {
"customerId": "<string>",
"name": "<string>"
},
"productOffering": {
"productOfferingId": "<string>",
"name": "<string>",
"price": {
"currency": "USD",
"discount": 5,
"netPrice": 5,
"priceType": "ONE_TIME",
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"productOfferingGroupId": "<string>",
"group": {
"productOfferingGroupId": "<string>",
"name": "<string>",
"category": "SUBSCRIPTION_CELL"
}
},
"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",
"discount": 5,
"netPrice": 5,
"priceType": "ONE_TIME",
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"productOfferingGroupId": "<string>",
"group": {
"productOfferingGroupId": "<string>",
"name": "<string>",
"category": "SUBSCRIPTION_CELL"
}
}
},
"cancelledAt": "2023-12-25",
"pausedAt": "2023-12-25",
"metadata": {}
}
],
"pagination": {
"total": 123,
"limit": 123,
"offset": 123,
"sort": {
"key": "<string>",
"direction": "ASC"
}
}
}List licenses
List all licenses.
A valid request URL is required to generate request examples{
"items": [
{
"licenseId": "<string>",
"status": "PENDING",
"type": "<string>",
"customer": {
"customerId": "<string>",
"name": "<string>"
},
"productOffering": {
"productOfferingId": "<string>",
"name": "<string>",
"price": {
"currency": "USD",
"discount": 5,
"netPrice": 5,
"priceType": "ONE_TIME",
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"productOfferingGroupId": "<string>",
"group": {
"productOfferingGroupId": "<string>",
"name": "<string>",
"category": "SUBSCRIPTION_CELL"
}
},
"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",
"discount": 5,
"netPrice": 5,
"priceType": "ONE_TIME",
"boundMonths": 12,
"billingCycle": {
"period": "MONTHLY",
"interval": 1
}
},
"productOfferingGroupId": "<string>",
"group": {
"productOfferingGroupId": "<string>",
"name": "<string>",
"category": "SUBSCRIPTION_CELL"
}
}
},
"cancelledAt": "2023-12-25",
"pausedAt": "2023-12-25",
"metadata": {}
}
],
"pagination": {
"total": 123,
"limit": 123,
"offset": 123,
"sort": {
"key": "<string>",
"direction": "ASC"
}
}
}Authorizations
An API key that grants access to the Connect API. You can create and manage API keys in the portal.
Query Parameters
The unique identifier of the customer to filter by.
The type of license to filter by.
The type of license, categorizing the software product or service into various telecommunications license types.
The maximum number of items to return.
1 <= x <= 1000The number of items to skip before starting to collect the result set.
x >= 0Response
A list of licenses.
Show child attributes
Show child attributes
The unique identifier for the license.
The status of the license.
PENDING, ACTIVE, PAUSED, CANCELLED, BLOCKED The type of license, categorizing the software product or service into various telecommunications license types.
Embedded representation of a product offering.
Show child attributes
Show child attributes
The unique identifier for the product offering.
The name of the product offering.
Pricing information with discount details.
Show child attributes
Show child attributes
The currency code.
"USD"
The discount amount from the original price.
The final cost after all discounts are applied.
5
The type of pricing model applied to the product offering.
ONE_TIME, RECURRING The number of months the price is bound to (for recurring prices).
12
The unique identifier for the product offering group.
Product offering group information embedded in responses.
Show child attributes
Show child attributes
The unique identifier for the product offering group.
The name of the product offering group.
A product category is a sub-type for grouping offerings of the same type.
Typically, product offerings of the same type with the same category allow for switching between them. For upgrading and downgrading subscriptions and licenses, we recommend using their corresponding endpoints though.
"SUBSCRIPTION_CELL"
The date and time when the license was activated.
Assignment details for a license, indicating what entity the license is assigned to. This embedded version includes additional display information for each assignment type.
Show child attributes
Show child attributes
Additional license details specific to certain license types.
Details about when a pending status change is scheduled for this license.
Pending product offering change.
Show child attributes
Show child attributes
The date when the pending product offering change is scheduled to occur.
Embedded representation of a product offering.
Show child attributes
Show child attributes
The unique identifier for the product offering.
The name of the product offering.
Pricing information with discount details.
Show child attributes
Show child attributes
The currency code.
"USD"
The discount amount from the original price.
The final cost after all discounts are applied.
5
The type of pricing model applied to the product offering.
ONE_TIME, RECURRING The number of months the price is bound to (for recurring prices).
12
The unique identifier for the product offering group.
Product offering group information embedded in responses.
Show child attributes
Show child attributes
The unique identifier for the product offering group.
The name of the product offering group.
A product category is a sub-type for grouping offerings of the same type.
Typically, product offerings of the same type with the same category allow for switching between them. For upgrading and downgrading subscriptions and licenses, we recommend using their corresponding endpoints though.
"SUBSCRIPTION_CELL"
The date and time when the license was cancelled (if applicable).
The date and time when the license was paused (if applicable).
Show child attributes
Show child attributes
The total number of items available.
The maximum number of items to return.
The number of items to skip before starting to collect the items.