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

List all-time usage records

Lists all-time usage records for the account identified by AccountSid. Use Category, StartDate, and EndDate to filter the records, and IncludeSubaccounts to control whether usage from subaccounts is included.

8 parameters
AccountSidstringrequired
The SID of the account whose usage records to retrieve. Must be 34 characters: `AC` followed by 32 hexadecimal characters.
Categorystringoptional
Filter usage records by usage category.
StartDatestringoptional
Include usage on or after this GMT date in `YYYY-MM-DD` format, or use a relative offset such as `-30days`.
EndDatestringoptional
Include usage on or before this GMT date in `YYYY-MM-DD` format, or use a relative offset such as `+30days`.
IncludeSubaccountsbooleanoptional
Whether to include usage from the master account and its subaccounts. Defaults to true when omitted; set to false to retrieve usage only from the specified account.
PageSizeintegeroptional
Number of resources per page. Defaults to 50 when omitted. Must be between 1 and 1000.
Pageintegeroptional
Page index for client state. Must be zero or greater.
PageTokenstringoptional
Page token provided by the API for retrieving a page of results.

1 status code
200Returns a paginated response containing all-time usage records and pagination metadata, including the current page, page size, and page navigation URIs.
endintegeroptional
first_page_uristringoptional
next_page_uristringoptional
pageintegeroptional
page_sizeintegeroptional
previous_page_uristringoptional
startintegeroptional
uristringoptional
usage_recordsarray<object>optional

Error handling

AccountSid must be a 34-character account SID beginning with AC, followed by 32 hexadecimal characters. PageSize must be between 1 and 1000, Page must be zero or greater, and StartDate and EndDate use GMT dates in YYYY-MM-DD format or the documented relative-date offsets.