Usage Records

The UsageRecords REST resource provides a simple API to retrieve usage made by your Restcomm account during any time period and by any usage category. This makes it easy to build reporting and analytics tools for your application. UsageRecords used in combination with
Subaccounts created for each of your end-users make it possible to build recurring usage-based billing systems on top of Restcomm’s API with just a few simple API calls.

You can also set up usage triggers to notify your application when a particular category of usage reaches a threshold on a daily, monthly, yearly, or all-time basis. Triggers can help determine if your users have reached a cap on usage, or if your application may have runaway requests. For more on usage triggers, see the Usage Triggers documentation.

UsageRecords List Resource

Resource URI

/<b>2012-04-24</b>/Accounts/{AccountSid}/Usage/Records

Resource Properties

This resource and its subresources always return a list of UsageRecords. Each UsageRecord is represented by the following
properties:

Usage, Count, and Price

Each UsageRecord contains three amounts: Usage, Count, and Price. Usage is the primary way usage is measured for that
category: minutes for calls, messages for SMS, etc. Count is the number of usage events: calls for calls, etc. And Price is
the price of the usage in the currency associated with the account.

Each UsageRecord also has fields that show the units in which each amount is measured: Usage is measured in units of UsageUnit, for instance. These fields make it easy to build usage dashboards. For example, you can always display human-readable strings describing
usage with “$Usage $UsageUnits“, “$Count $CountUnits“, or “$Price $PriceUnits“.

Usage Categories

A UsageRecord’s Category defines the type of usage it represents. The full list of all categories is here, but
you’ll usually focus on just a few common categories:

HTTP GET

Returns UsageRecords for all usage categories. The list includes paging information.

List Filters

By default, the UsageRecords resource will return one UsageRecord for each Category, representing all usage accrued all-time for the
account. You can filter the usage Category or change the date-range over which usage is counted using optional GET query parameters. Note that query parameters are case-sensitive:

For example, you might request all usage records for the month of April, 2012. In this case, the query string would be
StartDate=2012-04-01&EndDate=2012-04-30.

This would return one UsageRecord for each usage-type summarizing the usage during April. The list includes paging information.

It’s also possible to group usage by day, by month, or by year using the subresources described below.

List Subresources

The main UsageRecords list resource supports a variety of convenience
subresources. In general these take the form:

/2010-04-01/Accounts/{AccountSid}/Usage/Records/{Subresource}

Supported subresources are:

These convenience subresources can be used to draw a graph of daily calls, display dashboards of monthly usage across all usage categories, or build a simple usage-based billing system based on last month’s usage totals.

All subresources support the same list filters as the root UsageCounters resource.

Not supported.

HTTP PUT

Not supported.

HTTP DELETE

Not supported.

Full List of All Usage Categories

The full list of supported usage categories are:

UsageRecords Instance Resource

You cannot make requests directly to a UsageRecord resource. Instead,
make a request to the UsageRecords list resource or one of
its