Premium APIsSoftware ManagementSoftware Management V3API Reference Pages V3
Get FOTA Subscription
Get FOTA Subscriptions
GET /subscriptions/{accountName}
Retrieves the number of FOTA subscriptions for devices by account. This API returns information for licenses applied to devices.
HTTP Request
GET https://thingspace.verizon.com/api/fota/v3/subscriptions/{accountName}
Header Parameters
The request header must contain a current ThingSpace authorization token, set the content to "JSON" and a current VZ-M2M-session token.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization (required) | string | HTTP Authorization request header containing a valid Bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token (required) | string | A valid session token returned by a Connectivity Management POST /session/login request. |
| Content-Type (required) | string | Must be application/json. |
Request Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName (required) | string | Account identifier. This is numeric and in the format of 0000123456-00001. Leading zeros must be included. |
Request Body
None
Success Response
Status 200
{
"accountName": "0000123456-000001",
"purchaseType": "TS-HFOTA-EVNT,TS-HFOTA-MRC",
"licenseCount": 500,
"licenseUsedCount": 400,
"updateTime": "2020-09-17T21:11:32.170Z"
}Response Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName | string | The name (number) of the billing account. |
| purchaseType | string | Comma-separated list of subscription models used by the account: TS-HFOTA-MRC - a monthly recurring contract for a fixed number of licenses. TS-HFOTA-EVNT - a post-pay plan in which the account is billed for the number of licenses used in each month (the number of events). Both of the above can be included. |
| licenseCount | integer | The Number of monthly licenses in an MRC subscription. This is zero for accounts that have only Event subscriptions. |
| licenseUsedCount | integer | The number of licenses currently assigned to devices. |
| updateTime | string($date-time) | The date and time when the subscription was last updated. |
Failure Responses
All error messages are returned in this format:
{
"errorCode": "error code string",
"errorMessage": "error message string"
}Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.