UsageRecord

Usage records track subscription usage for users. This includes data, voice, and text usage. Note that there is a delay in usage data that varies between carriers.

Name
object
Type
string
Description
Type of object is always usageRecord.
Allowed values: usageRecord
Name
data
Type
integer
Description
Amount of data used in bytes.
Example: 18883100
Name
dataTethering
Type
integer
Status
PREVIEW
Description
Amount of tethering data used in bytes.
Optional: This property may not always be included.
Example: 30029300
Name
end
Type
string
Description
Timestamp representing the exclusive upper bound of the aggregation period (e.g. the end of a 24 hour period, subscription period or user-defined set of dates).
Example: "2021-02-15T00:00:00Z"
Name
labels
Type
object
Description
An object containing optional metadata about the usage record.
Name
country
Type
string
Description
The ISO 3166-1 alpha-2 country code of the country in which the usage occurred.
Optional: This property may not always be included.
Example: "US"
Name
roaming
Type
string
Status
PREVIEW
Description
The roaming mode the usage occurred in.
Optional: This property may not always be included.
Allowed values: none international domestic
Name
subscription
Type
string
Description
The unique identifier for the subscription to which the usage is attributed.
Optional: This property may not always be included.
Example: "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
Name
sms
Type
integer
Description
Amount of SMS messages sent and received.
Example: 15
Name
smsInternational
Type
integer
Status
PREVIEW
Description
Amount of SMS messages sent internationally.
Optional: This property may not always be included.
Example: 6
Name
start
Type
string
Description
Timestamp representing the inclusive lower bound of the aggregation period (e.g. the start of a 24 hour period, subscription period or user-defined set of dates)
Example: "2021-02-14T00:00:00Z"
Name
voice
Type
integer
Description
Amount of voice usage in seconds.
Example: 240
Name
voiceInternational
Type
integer
Status
PREVIEW
Description
Amount of international voice usage in seconds.
Optional: This property may not always be included.
Example: 125

Example

{
  "object": "usageRecord",
  "data": 18883100,
  "dataTethering": 30029300,
  "end": "2021-02-15T01:01:01.0Z",
  "labels": {
    "country": "US",
    "roaming": "none",
    "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
  },
  "sms": 15,
  "smsInternational": 6,
  "start": "2021-02-14T01:01:01.0Z",
  "voice": 240,
  "voiceInternational": 125
}