Retrieves the total number of SIM-Secure for IoT subscription licenses purchased for your account by license type, and lists the number of licenses assigned and available for each license type.
POST /accounts/subscriptions/actions/list
You can retrieve the list of licenses and license types using only your account number, or by using both account number and SKU number.
When new licenses are purchased or licenses are removed, the license counts in your account update accordingly.
POST https://thingspace.verizon.com/api/m2m/v1/accounts/subscriptions/actions/listNone.
The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization required |
string | HTTP Authorization bearer token. |
| VZ-M2M-TOKEN required |
string | A valid session token returned by POST /session/login. |
| Content-Type required |
string | Must be application/json. |
The request body identifies the account name for which you want to show subscription information by licenses and license types. You can also specify the SKU number in the request body to retrieve license information for a specific license type.
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName required |
string | The name of a billing account, including any leading zeroes. |
| skuNumber required |
string (20 characters max string) | The Stock Keeping Unit (SKU). Valid skuNumbers for SIM-Secure for IoT are:
|
Your request includes only the accountName.
{
"accountName":"0000123456-00001"
}
Your request includes both the accountName and the skuNumber.
{
"accountName":"0000123456-00001",
"skuNumber":"SIMSec-IoT-Lt"
}
Status 200 A successful request returns an array of subscriptionList objects.
| Property | Data Type | Description |
|---|---|---|
| accountName | string | The name of the billing account. |
| subscriptionList | array of subscriptionList objects | The list of SKU numbers and counts for each license type specified in the request. |
| skuNumber | string | The skuNumber that identifies the license type. SIMSec-IoT-Lt”. (Lifetime) Once a license is assigned to a SIM, the SIM-Secure feature is enabled for the life of the SIM. “TS-BUNDLE-KTO-SIMSEC-MRC”. (Bundle) The SIM-Secure Flex license can be assigned to or removed from a SIM at any time. This SKU is bundled with other ThingSpace Services. “SIMSec-IoT”. (Flex) The SIM-Secure Flex license can be assigned to or removed from a SIM at any time. This SKU is purchased a la carte. "TSS-IOT-INTLG-TIERED-SIMSEC". (Intelligent Bundle) The SIM-Secure flexible license included in the intelligence bundle. |
| licenseType | string | The license type associated with the skuNumber. |
| licensePurchased | integer | The total number of licenses purchased for the license type. |
| licenseAssigned | integer | The total number of licenses for this license type that are assigned to device SIMs. |
| licenseAvailable | integer | The total number of licenses for this license type that are available to assign to device SIMs. |
An example response when the request body included only the accountName. Information for all license types associated with the account is returned.
{
"accountName":"0000123456-00001",
"subscriptionList":[
{
"skuNumber":"SIMSec-IoT-Lt",
"licenseType":"Lifetime",
"licensePurchased":336000,
"licenseAssigned":507,
"licenseAvailable":335493
},
{
"skuNumber":"SIMSEC-IoT",
"licenseType":"Flexible",
"licensePurchased":100,
"licenseAssigned":5,
"licenseAvailable":95
},
{
"skuNumber":"TS-BUNDLE-KTO-SIMSEC-MRC",
"licenseType":"Flexible Bundle",
"licensePurchased":200,
"licenseAssigned":7,
"licenseAvailable":193
}
]
}
An example response when your request body includes both the accountName and the skuNumber. Subscription information only for the specified license type is returned.
{
"accountName":"0000123456-00001",
"subscriptionList":[
{
"skuNumber":"SIMSec-IoT-Lt",
"licenseType":"Lifetime",
"licensePurchased":336000,
"licenseAssigned":507,
"licenseAvailable":335493
}
]
}
Error messages are returned in this format:
{
"errorCode": "error code string",
"errorMessage": "error message string"
}
| Error Code | Error Message | Description |
|---|---|---|
| Carrier.Service.INPUT_INVALID.Action.NotDefined | accountName is a required field. | Your request did not include an accountName. |