Premium APIsSoftware ManagementSoftware Management V2API Reference V2

Get subscription status

Get FOTA Subscription

GET /subscriptions/{accountName}

Retrieves the number of FOTA subscriptions for HTTP devices by account.

Uses and Requirements

This API returns information for licenses applied to HTTP devices.

HTTP Request

GET https://thingspace.verizon.com/api/fota/v2/subscriptions/{accountName}

Resource Path and Query Parameters

You must include the account name in the path.

Parameter NameData TypeDescription
accountName
required
stringAccount identifier.

Header Parameters

The request header must contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.

Parameter NameData TypeDescription
Authorization
required
stringHTTP Authorization bearer token:
Authorization: Bearer {token}
VZ-M2M-Token
required
stringA valid session token:
VZ-M2M-Token: {M2Mtoken}

Request Body

None

Example Request:

Retrieve the number of licenses assigned to HTTP devices for the account.

curl https://thingspace.verizon.com/api/fota/v2/subscriptions/0402196254-00001 \ 
-H 'Authorization: Bearer $AUTH_TOKEN' \ 
-H 'VZ-M2M-Token: $M2M_TOKEN'

Success Response

Status 200

ParameterData TypeDescription
accountNamestringThe name (number) of the billing account.
purchaseTypestringComma-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
licenseCountstringThe Number of monthly licenses in an MRC subscription. This is zero for accounts that have only Event subscriptions.
licenseUsedCountstringNumber of licenses currently assigned to devices.
updateTimestringThe date and time when the subscription was last updated.

Example Success Response

{
  "accountName": "00000000000-123345",
  "purchaseType": "TS-HFOTA-EVNT,TS-HFOTA-MRC",
  "licenseCount": 500,
  "licenseUsedCount": 400,
  "updateTime": "2020-09-17T21:11:32.170Z"
}

Failure Response

Status 400

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.

On this page