Get Subscription Information for SIM-Secure for IoT

Get Subscription Information for SIM-Secure for IoT
POST /accounts/subscriptions/actions/list

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.

Contents

Uses and Requirements

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.

Request Components

HTTP Request

POST https://thingspace.verizon.com/api/m2m/v1/accounts/subscriptions/actions/list

Resource Path and Query Parameters

None.

Header Parameters

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.

Request Body

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.
skuNumber
required
string (20 characters max string) The Stock Keeping Unit (SKU). Valid skuNumbers for SIM-Secure for IoT are:
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.

Example Request Body, Account Name only

Your request includes only the accountName.

{
   "accountName":" SimSecureLegacyCPNStaticAcct1"
}

Example Request Body, Account Name and SKU Number

Your request includes both the accountName and the skuNumber.

{
   "accountName":"SimSecureLegacyCPNStaticAcct1",
   "skuNumber":"SIMSec-IoT-Lt"
}

Success Responses

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.
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.

Example Success Response for Account Name

An example response when the request body included only the accountName. Information for all license types associated with the account is returned.

{
   "accountName":"SimSecureLegacyCPNStaticAcct1",
   "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
      }
   ]
}

Example Success Response for Account Name and SKU Number

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":"SimSecureLegacyCPNStaticAcct1",
   "subscriptionList":[
      {
         "skuNumber":"SIMSec-IoT-Lt",
         "licenseType":"Lifetime",
         "licensePurchased":336000,
         "licenseAssigned":507,
         "licenseAvailable":335493
      }
   ]
}

Failure Responses

Error messages are returned in this format:

{
  "errorCode": "error code string",
  "errorMessage": "error message string"
}

Error Codes and Messages

Error Code Error Message Description
Carrier.Service.INPUT_INVALID.Action.NotDefined accountName is a required field. Your request did not include an accountName.