UsageRecord Resource
Super SIM’s Usage Records API is currently in Public Beta. Some features are not yet implemented and others may be changed before the product is declared as Generally Available. Beta products are not covered by a Twilio SLA. Learn more about beta product support.
To avoid ambiguity throughout this page, Sim (initial cap) refers to the Sim API resource. SIM (all caps) refers to the physical Subscriber Identity Module (that is, a SIM card) associated with a Sim resource.
A UsageRecord represents aggregated usage information over a specified period. Usage data can be filtered to show usage for a specific resource (e.g., one Super SIM or Network) or grouped around a type of resource (e.g., Sims or Networks) where one record will be returned for each resource of that type for which usage occurred during the requested period. If you want to slice up your results by UTC day or UTC hour, you can control the granularity of the results.
All dates and times are presented in UTC.
The amounts in UsageRecords are presented in the period when the usage occurred, not when it was received and processed by Twilio. This is to better associate the information from this resource with real-world events.
UsageRecord properties
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The SID of the Account that incurred the usage. |
sim_sid
|
SID of a Sim resource to which the UsageRecord belongs. Value will only be present when either a value for the |
network_sid
|
SID of the Network resource the usage occurred on. Value will only be present when either a value for the |
fleet_sid
|
SID of the Fleet resource the usage occurred on. Value will only be present when either a value for the |
iso_country
|
Alpha-2 ISO Country Code that the usage occurred in. Value will only be present when either a value for the |
period
|
The time period for which the usage is reported. The period is represented as a pair of |
data_upload
|
Total data uploaded in bytes, aggregated by the query parameters. |
data_download
|
Total data downloaded in bytes, aggregated by the query parameters. |
data_total
|
Total of data_upload and data_download. |
data_total_billed
|
Total amount in the |
billed_unit
|
The currency in which the billed amounts are measured, specified in the 3 letter ISO 4127 format (e.g. |
Read UsageRecord resources
https://supersim.twilio.com/v1/UsageRecords
Retrieve a list of UsageRecords over a specified period aggregated according to the specified granularity.
Usage information will be retained for 18 months, after which it will be deleted. Requests querying usage records older than 18 months will return an exception.
Which resources’ usage data you receive will depend on the Account SID you provide to authorize your API access. If you authorize a request using a parent Account’s credentials, the call will return only usage for resources belonging to that parent Account. SIMs belonging to the parent’s Subaccounts, if it has any, will not be included. To request usage information for a given Subaccount, authorize the request with that Subaccount’s credentials. Only that Subaccount’s resources’ data will be returned.
Parameters
| Parameters in REST API format | |
|---|---|
sim
Optional
|
SID or unique name of a Sim resource. Only show UsageRecords representing usage incurred by this Super SIM. |
fleet
Optional
|
SID or unique name of a Fleet resource. Only show UsageRecords representing usage for Super SIMs belonging to this Fleet resource at the time the usage occurred. |
network
Optional
|
SID of a Network resource. Only show UsageRecords representing usage on this network. |
iso_country
Optional
|
Alpha-2 ISO Country Code. Only show UsageRecords representing usage in this country. |
group
Optional
|
Dimension over which to aggregate usage records. Can be: |
granularity
Optional
|
Time-based grouping that UsageRecords should be aggregated by. Can be: |
start_time
Optional
|
Only include usage that occurred at or after this time, specified in ISO 8601 format. Default is one month before the |
end_time
Optional
|
Only include usage that occurred before this time (exclusive), specified in ISO 8601 format. Default is the current time. |
Exclusive End Time
The end_time query parameter is exclusive. Usage that occurred before the end_time will be returned. For example to request all of the usage that occurred on February 20, 2022, you should use the the following start_time and end_time request parameters:
start_time: 2022-02-20T00:00:00Zend_time: 2022-02-21T00:00:00Z
Single SIM Usage Requests versus Account Usage Requests
Queries that are made for a single SIM by passing in a value for the Sim parameter require less computational work to aggregate the results than do requests which encompass all SIMs on your Account. Therefore queries for a single SIM may support longer ranges between the StartTime and EndTime parameters or may support queries made for any valid UTC timestamp as opposed to requiring the timestamps fall on a UTC hour or day boundary. Consequently, the sections below may be read in two ways, each depending on whether the request you are making is a Single SIM Usage Request or an Account Usage Request:
- Single SIM Usage Requests — These are requests made with the
Simparameter set. They return UsageRecords representing usage only incurred by that Super SIM. - Account Usage Requests — These are requests made without any
Simparameter set. They return UsageRecords representing usage incurred by all Super SIMs in your Account.
Read filtered UsageRecords
You can filter UsageRecords to show usage for a specific resource such as a single SIM or Network.
The following query parameters will give you filtered UsageRecords:
Sim— Only show usage for the requested Sim resource. Can be passed in as either the Sim resource’sSidorUniqueName.Fleet— Only show usage for Super SIMs that were assigned to this Fleet resource when the usage occurred. Can be passed in as either the Fleet resource’sSidorUniqueName.Network— Only show usage on this cellular network. Only accepts the Network resource’sSidasFriendlyNamesare subject to change.IsoCountry— Only show usage incurred on cellular networks in this country.IsoCountrywill be determined based on theIsoCountryof the Network resource on which the usage occurred.
When a filter is applied, the corresponding parameter on each UsageRecord will be populated with this value. For example, if you filter by a Sim resource, each UsageRecord returned will have the Sim resource’s Sid in the SimSid property.
Multiple filters can be applied at once. For example, you can provide values for both Sim and Network to see the usage that a single Super SIM incurred on the requested cellular network.
Read UsageRecords over time
Each UsageRecord will represent the usage incurred over a period of time. The unit of time that each record represents depends on the Granularity query parameter. You can set the Granularity to either all, day, or hour. The default value is all.
The maximum allowed range between the StartTime and EndTime will vary depending on the Granularity you select and whether or not you are making a Single SIM Usage Request or an Account Usage Request. Further limitations on the allowed range may be imposed if you group your UsageRecords by a resource type as documented in the Group UsageRecords by resource type section below.
Single SIM Usage Requests
Requests for the usage incurred by a single SIM must be made using the following rules for each Granularity:
all— One record will be returned representing the usage for the entire period between theStartTimeandEndTime. YourStartTimeandEndTimerequest parameters can be any valid UTC timestamp. The maximum allowed query period is 18 months.day— One record will be returned for each UTC day between theStartTimeandEndTime(exclusive). YourStartTimeandEndTimerequest parameters must fall on midnight UTC (e.g.,2021-08-19T00:00:00Z) whenGranularity=dayor they will be rejected. The maximum allowed query period is 3 months.hour— One record will be returned for each UTC hour between theStartTimeandEndTime(exclusive). YourStartTimeandEndTimerequest parameters must fall on a UTC hour (e.g.,2021-08-19T03:00:00Z) whenGranularity=houror they will be rejected. The maximum allowed query period is 31 days.
Account Usage Requests
Requests for the usage incurred by all the Super SIMs in your Account must be made using the following rules for each Granularity:
all— One record will be returned representing the usage for the entire period between theStartTimeandEndTime. YourStartTimeandEndTimerequest parameters must fall on a UTC hour (e.g.,2021-08-19T03:00:00Z) whenGranularity=allor they will be rejected. The maximum allowed query period is 18 months.day— One record will be returned for each UTC day between theStartTimeandEndTime(exclusive). YourStartTimeandEndTimerequest parameters must fall on midnight UTC (e.g.,2021-08-19T00:00:00Z) whenGranularity=dayor they will be rejected. The maximum allowed query period is 3 months.hour— One record will be returned for each UTC hour between theStartTimeandEndTime(exclusive). YourStartTimeandEndTimerequest parameters must fall on a UTC hour (e.g.,2021-08-19T03:00:00Z) whenGranularity=houror they will be rejected. The maximum allowed query period is 31 days.
Your Account has non-standard permissions and may have different behavior
You are seeing the following section because you have been identified as using this API before we implemented requirements that the StartTime and EndTime request parameters must fall on UTC day or hour boundaries depending on whether you were making a Single SIM Usage Request or an Account Usage Request and what Granularity was used. To avoid disrupting your application and to continue returning results consistent with what you may previously received, we have enabled a flag on your account to preserve the previous behavior rather than reject your requests.
Granularity hour and day
Your StartTime and EndTime values will be effectively rounded up to the next UTC hour or UTC day if the values provided do not fall on a UTC hour or UTC day boundary, respectively. For example, a request made with Granularity=day with StartTime=2021-07-01T00:30:00Z (July 1, 2021 12:30am UTC) and EndTime=2021-07-15T14:00:00Z (July 15, 2021 2:00pm UTC) will return results from the start of July 2nd through the end of July 15th. Similarly, a request made with Granularity=hour with StartTime=2021-07-01T00:30:00Z (12:30am UTC) and EndTime=2021-07-01T10:30:00Z (10:30am UTC) will return results for 1:00am UTC to 11:00am UTC.
To ensure that you receive the expected results, it is recommended that you make all requests with Granularity=hour with StartTime and EndTime values that fall on a UTC hour boundary (e.g., StartTime=2021-07-01T00:00:00Z) and all requests with Granularity=day with StartTime and EndTime values that fall on midnight UTC (e.g., EndTime=2021-07-16T00:00:00Z).
Granularity all
For Account Usage requests made with Granularity=all, if your StartTime and EndTime parameters are less than one hour apart, the results of all raw usage records where the measured period started between the StartTime and the EndTime will be aggregated. If your StartTime and EndTime parameters are more than one hour apart, then both the StartTime and EndTime parameters will be rounded up to the nearest UTC hour as described in the section above for Granularity=hour.
To ensure that you receive expected results, you should make all Account Usage requests with StartTime and EndTime values that fall on a UTC hour boundary.
Single SIM Usage Requests made with Granularity=all will correctly return the usage that occurred between any StartTime and EndTime up to the allowed range. This is a result of how these requests are processed — see Single SIM Usage Requests versus Account Usage Requests for details.
Example 1
Example 2
Example 3
Example 4
Example 5
Example 6
Example 7
Group UsageRecords by resource type
You can group UsageRecords around a type of resource (e.g., Sims or Networks). Each UsageRecord represents the aggregated usage incurred by an instance of the resource (e.g. a Sim or a Network) over a period of time.
Grouping your UsageRecords by SIM or by Fleet is currently in Private Beta. To request access to this functionality, contact your Twilio Account Executive.
You can group your UsageRecords by the following resource types:
sim— Group usage by Super SIM. Each UsageRecord represents the usage incurred by a Sim resource over the UsageRecord’s period. When grouping usage by Super SIM, the maximum allowed query period between theStartTimeandEndTimeis 31 days for allGranularityvalues. This functionality is in Private Beta and you may need it unlocked on your Twilio Account.fleet— Group usage by Fleet. Each UsageRecord represents the usage incurred by all the Super SIMs assigned to a Fleet resource when the usage occurred over the UsageRecord’s period. This functionality is in Private Beta and you may need it unlocked on your Twilio Account.network— Group usage by Network. Each UsageRecord represents the usage incurred on a Network resource over the UsageRecord’s period.isoCountry— Group usage by country. Each UsageRecord represents the usage incurred on all of the Network resources in a country over the UsageRecord’s period.
When a grouping is applied, the corresponding resource type’s parameter on each UsageRecord will be populated with its identifier. For example, if you group by sim, each UsageRecord returned will have the Sim resource’s Sid in the SimSid property.
You can filter grouped UsageRecords.
Data Usage Processing
Usage events containing how much data your SIMs used are simulataneously handed off to the aggregation engine that powers the UsageRecords API and Twilio's billing system. As a result, for each event handled, the usage in bytes will be reflected in the results from the UsageRecords API before the amount charged will be. Once the usage event has been processed by our billing system and the output billing event is received by the aggregation engine, it too will be reflected in the results via the data_total_billed property. All data billing events should be received and reflected in your results within 24 hours from when the usage occurred.
When generating critical spending reports, such as those you may need for monthly reporting for your business' operations, using this API, we recommend you wait at least 24 hours after the reported period ends to generate the report to allow usage events to be processed, charged, and reflected in your results.
Example 8
Example 9
Example 10
Example 11
Example 12
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
