List usage record monthly

GET /2010-04-01/Accounts/{AccountSid}/Usage/Records/Monthly.json

Usage records summarized by month

Path parameters

  • AccountSid string Required

    The SID of the Account that created the UsageRecord resources to read.

Query parameters

  • Category string

    The usage category of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved.

  • StartDate string(date)

    Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: -30days, which will set the start date to be 30 days before the current date.

  • EndDate string(date)

    Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD. You can also specify offsets from the current date, such as: +30days, which will set the end date to 30 days from the current date.

  • IncludeSubaccounts boolean

    Whether to include usage from the master account and all its subaccounts. Can be: true (the default) to include usage from the master account and all subaccounts or false to retrieve usage from only the specified account.

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • end integer
    • first_page_uri string(uri)
    • next_page_uri string(uri)
    • page integer
    • page_size integer
    • previous_page_uri string(uri)
    • start integer
    • uri string(uri)
    • usage_records array[object]
      Hide usage_records attributes Show usage_records attributes array[object]
      • account_sid string | null

        The SID of the Account accrued the usage

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • api_version string | null

        The API version used to create the resource

      • as_of string | null

        Usage records up to date as of this timestamp

      • category string | null

        The category of usage

      • count string | null

        The number of usage events

      • count_unit string | null

        The units in which count is measured

      • description string | null

        A plain-language description of the usage category

      • end_date string(date) | null

        The last date for which usage is included in the UsageRecord

      • price number | null

        The total price of the usage

      • price_unit string(currency) | null

        The currency in which price is measured

      • start_date string(date) | null

        The first date for which usage is included in this UsageRecord

      • subresource_uris object(uri-map) | null

        A list of related resources identified by their relative URIs

      • uri string(uri) | null

        The URI of the resource, relative to https://api.twilio.com

      • usage string | null

        The amount of usage

      • usage_unit string | null

        The units in which usage is measured
GET /2010-04-01/Accounts/{AccountSid}/Usage/Records/Monthly.json 
curl \
 -X GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Usage/Records/Monthly.json \
 --user "username:password"
Response examples (200) 
{
  "end": 42,
  "first_page_uri": "https://example.com",
  "next_page_uri": "https://example.com",
  "page": 42,
  "page_size": 42,
  "previous_page_uri": "https://example.com",
  "start": 42,
  "uri": "https://example.com",
  "usage_records": [
    {
      "account_sid": "string",
      "api_version": "string",
      "as_of": "string",
      "category": "a2p-registration-fees",
      "count": "string",
      "count_unit": "string",
      "description": "string",
      "end_date": "2023-05-04",
      "price": 42.0,
      "price_unit": "string",
      "start_date": "2023-05-04",
      "subresource_uris": {},
      "uri": "https://example.com",
      "usage": "string",
      "usage_unit": "string"
    }
  ]
}
Response examples (200) 
{
  "end": 42,
  "first_page_uri": "https://example.com",
  "next_page_uri": "https://example.com",
  "page": 42,
  "page_size": 42,
  "previous_page_uri": "https://example.com",
  "start": 42,
  "uri": "https://example.com",
  "usage_records": [
    {
      "account_sid": "string",
      "api_version": "string",
      "as_of": "string",
      "category": "a2p-registration-fees",
      "count": "string",
      "count_unit": "string",
      "description": "string",
      "end_date": "2025-05-04",
      "price": 42.0,
      "price_unit": "string",
      "start_date": "2025-05-04",
      "subresource_uris": {},
      "uri": "https://example.com",
      "usage": "string",
      "usage_unit": "string"
    }
  ]
}