List ledger entries

GET

/api/v1/ledger

Docs menu

Every change to your balance, newest first: top-ups, holds, returns and the rest. The ledger is append-only.

Key
Bearer key, test or live
Scope
read

Parameters

limitintegeroptional

How many objects to return, 1 to 100. Default 20.

Default: 20

starting_afterstringoptional

The id of the last object you have. Returns the objects after it. Newest first.

Response

200. A page of ledger entries.

objectstring

list

dataarray of object
Show child fields
idstring

led_...

objectstring

ledger_entry

kindstring

topuptopup_reversalgrantholdhold_returnpublishpublish_refundexpiryrefund_unused

amountinteger

Signed credits.

subjectobject or null
balance_afterinteger
created_atstring
has_moreboolean
next_starting_afterstring or null

Pass this as starting_after to read the next page.

Errors

CodeStatusMeaning
missing_scope403The API key does not have the scope this endpoint needs.
limit_invalid400The limit must be a whole number from 1 to 100.
cursor_invalid400The starting_after cursor does not name an object in this list.

Any request can also fail with missing_api_key, invalid_api_key, api_key_revoked, rate_limited or internal_error. See Errors.

In test mode