Get FOTA Subscription

Get FOTA Subscription

GET /subscriptions/{acc}

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

Uses and Requirements

This API returns information for licenses applied to HTTP devices. 

Request Components

HTTP Request

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

Resource Path and Query Parameters

You must include the account name in the path.

Parameter Name Data Type Description
acc
required
string Account identifier.

Header Parameters

The request header must contain a current ThingSpace authorization token and a current VZ-M2M-session token.

Parameter Name Data Type Description
Authorization
required
string HTTP Authorization request header containing a valid Bearer token.
VZ-M2M-Token
required
string A valid session token returned by a Connectivity Management POST /session/login request.

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 Responses

Status 200

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
licenseCount integer The Number of monthly licenses in an MRC subscription. This is zero for accounts that have only Event subscriptions.
licenseUsedCount integer Number of licenses currently assigned to devices.
updateTime string($date-time) The 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 Responses

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.