Skip to content
Documentation
GuidesAPI ReferenceIntegrations
ArenaPlatform
API Reference/Billing and Credits

List Ledger Entries

GET/v1/ledger

Authorization

Authorizationstring · headerRequired

AudioLab API key sent as Bearer <token>. Authentication guide

Parameters

limitquery · integer
cursorquery · string
viewquery · string

Use transactions for posted charges, purchases, and adjustments, excluding temporary holds and hold releases.

Responses

200Ledger page.
application/json
dataobject[]Required
Show nested fields
idstringRequired
workspace_idstringRequired
request_idstring | null
key_idstring | null

API key that incurred the charge, when associated with a request.

key_namestring | null

Display name of the API key, including revoked keys.

purchase_idstring | null

Credit purchase associated with this row; null for grants and internal ledger entries.

kindstringRequired

Values: "credit""reserve""charge""refund""adjust""fee"

amountnumberRequired
currencystringRequired
balancenumberRequired
statestringRequired

Values: "pending""posted""void"

notestring | null
created_atstringRequired
next_cursorstring | null
401Authentication is missing or invalid.
application/json
errorobjectRequired
Show nested fields
codestringRequired
messagestringRequired
paramstring | null
request_idstring | null
metadataobject

Typed detail for some refusals. budget_exceeded (402): limit (key_budget or workspace_budget) and budget with scope, period, limit, usage and resets_at. key_limit_exceeded (402): limit key_spend_limit. access_denied (403): policy (workspace or key), rule (models, providers or products), product, provider and model.

500Internal server error.
application/json
errorobjectRequired
Show nested fields
codestringRequired
messagestringRequired
paramstring | null
request_idstring | null
metadataobject

Typed detail for some refusals. budget_exceeded (402): limit (key_budget or workspace_budget) and budget with scope, period, limit, usage and resets_at. key_limit_exceeded (402): limit key_spend_limit. access_denied (403): policy (workspace or key), rule (models, providers or products), product, provider and model.