Usage Billing History
List the caller's usage-billing ledger entries, newest first.
Use types to filter the entries to list.
This is a paginated endpoint. See the Pagination guide for details on using cursor-based pagination.
Query parameters
Product whose ledger to read.
Comma-separated type values to return: usage_settled, top_up, void, expiry, or chargeback. When omitted, all types are returned. Rejects when an unrecognized name is supplied.
An opaque string used as the cursor for pagination. Must be used with the same parameters from the previous request
The number of objects to return in a page
Response
Successful Response
Example response
{
"currency": "usd",
"entries": [
{
"id": 8814,
"type": "usage_settled",
"created_at": "2026-06-10T14:00:00Z",
"category": "automation_run",
"status": "success",
"charged_units": 13700,
"charged_amount": 27400,
"credited_units": 5000000,
"credited_amount": 10000000,
"description": "Top-up USD 1000"
}
],
"next_cursor": "14540000435w8hj8pXXwPQJJch.X9DBH8ya2Xenok55"
}Changes
Changed in 3 of the 10 revisions of this API.27
- ○
added the new optional
queryrequest parametertypesnew-optional-request-parameter
- ○
- ▲
response property
entries/items/charged_unitslist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ▲
response property
entries/items/credited_unitslist-of-types was widened by adding typesnullto media typeapplication/jsonof response200response-property-list-of-types-widened
- ○
the response property
entries/items/charged_unitsbecame required for the status200response-property-became-required
- ○
the response property
entries/items/credited_unitsbecame required for the status200response-property-became-required
- ○
added the required property
currencyto the response with the200statusresponse-required-property-added
- ○
added the required property
entries/items/charged_amountto the response with the200statusresponse-required-property-added
- ○
added the required property
entries/items/credited_amountto the response with the200statusresponse-required-property-added
- ▲
- ○
endpoint added
endpoint-added
- ○