Retrieve Billed Usage

Retrieve Billed Usage :
POST /devices/usage/actions/billedusage

Gets billing usage for a customer segment for a specified billing cycle, or the most recent billing cycle if one is not specified.

Contents

Request Components

HTTP Request

POST https://thingspace.verizon.com/api/m2m/v1/devices/usage/actions/billedusage

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 Parameters

Parameter Name Data Type Description
accountName
required
string The name of a billing account. An account name is usually numeric, and must include any leading zeros.
labels
required if not specifying deviceId
Array of label names and label values Maximum of 2,000 objects are allowed in the array.
label.name
required
Varchar(20) The label associated with the device.

You can only provide either label or deviceId. Not both.

label.value
required
Varchar (50) The label value.
deviceId
required if not specifying label
deviceId object An identifier for a single device.

You can only provide either label or deviceId. Not both.

deviceId.kind,
deviceId.id
required if not specifying label*
string The type and value of the device identifier.
  • EID - decimal, 20 digits
billingCycle The billing cycle for which you want billing information. If you do not specify the billing cycle, the most recent billing cycle information is provided.
billingCycle.year integer The year in which the billing cycle occurs.
billingCycle.month integer The number representing the month of the billing cycle. Valid values include integers between 1 and 12.

Example Request Body

{
  "accountName": "0342330389-00001",
    "label": {
    "name": "VIN",
    "value": "1N4AL3AP2DC276747"
  },
  "deviceId": {
    "id": "666456789123456789123456784008",
    "kind": "EID"
  },
  "billingCycle": {
    "year": 2020,
    "month": 1
  }
}

Success Responses

Status 200

Response Parameters

Parameter Name Data Type Description
accountName
required
string The name of a billing account. An account name is usually numeric, and must include any leading zeros.
billingCycle The billing cycle for which you want billing information. If you do not specify the billing cycle, the most recent billing cycle information is provided.
billingCycle.year integer The year in which the billing cycle occurs.
billingCycle.month integer The number representing the month of the billing cycle. Valid values include integer values between 1 and 12.
deviceId
required if not specifying label
deviceId object An identifier for a single device.
deviceId.kind,
deviceId.id
required if not specifying label*
string The type and value of the device identifier.
  • EID - decimal, 20 digits
label
required if not specifying deviceId
Array of label names and label values Maximum of 2,000 objects are allowed in the array.
label.name
required
Varchar(20) The label associated with the device.
label.value
required
Varchar (50) The label value associated with the device.
ratePlanDescription string A description of the rate plan.
totalBilledAmount integer The total dollar amount billed for the specified billing cycle.
totalBilledUsage integer Total of usage in units of measure.
unitOfMeasure string Indicates the method in which totalBilledUsage is measured.
usageSegments array Breaks down the billing and usage details by rating groups.
ratingGroup string Breaks down billing and usage based on a contracted rate.
ratingGroupDetails array Lists charge and usage details for the billing cycles.
currentCycleDetails array Lists billing and usage details for the rating group for the specified billing cycle.
currentCycleDetails.chargeAmount integer The total dollar amount charged and usage information for the rating group by country code for the current billing cycle.
currentCycleDetails.countryCode string Code for the country that the usage and resulting charges are in.
currentCycleDetails.usage integer Total usage in the corresponding country for the billing cycle.
unbilledFromPreviousCycleDetails array of objects Lists usage and charge information from a previous billing cycle that was not billing until the current billing cycle.
unbilledFromPreviousCycleDetails.chargeAmount integer The total dollar amount charged in the rating group in the current billing cycle, but whose usage occurred in a prior cycle.
unbilledFromPreviousCycleDetails.countryCode string Code for the country in which the usage and resulting charges occurred in.
unbilledFromPreviousCycleDetails.usage integer Total usage from the unbilled cycle.

Example Success Response

{
  "accountName": "0342330389-00001",
  "billingCycle": {
    "month": 1,
    "year": 2020
  },
  "deviceId": {
    "id": "8991101200003204514",
    "kind": "EID"
  },
  "label": {
    "name": "VIN",
    "value": "1N4AL3AP2DC276747"
  },
  "ratePlanDescription": "?XXX?",
  "totalBilledAmount": 7283.34,
  "totalBilledUsage": 10485760123,
  "unitOfMeasure": "MB",
  "usageSegments": [
    {
      "ratingGroup": "SXM STRMG AUDIO DATA",
      "ratingGroupDetails": {
        "currentCycleDetails": [
          {
            "chargeAmount": 288,
            "countryCode": "US",
            "usage": 2000000
          },
          {
            "chargeAmount": 388,
            "countryCode": "CA",
            "usage": 3000000
          }
        ],
        "unbilledFromPreviousCycleDetails": [
          {
            "chargeAmount": 488,
            "countryCode": "MX",
            "usage": 5000000
          }
        ]
      }
    },
    {
      "ratingGroup": "SXM ACCT MGMT DATA",
      "ratingGroupDetails": {
        "currentCycleDetails": [
          {
            "chargeAmount": 588,
            "countryCode": "US",
            "usage": 5000000
          },
          {
            "chargeAmount": 688,
            "countryCode": "CA",
            "usage": 6000000
          }
        ],
        "unbilledFromPreviousCycleDetails": [
          {
            "chargeAmount": 788,
            "countryCode": "MEX",
            "usage": 7000000
          }
        ]
      }
    }
  ]
}

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.