Skip to content

List charges

List wallet transactions by pool and hour, newest first. Use before with the returned cursor for older entries.

Parameters

#
beforestring
Pagination cursor from the previous response. Returns older entries.
limitstring
Maximum transactions per page. Defaults to 50. Maximum 500.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
A page of wallet credits and charges.
Show 2 attributesHide attributes
entriesobject[] | nullAlways present
Ledger entries in this page.
Show 1 attributeHide attributes
itemsobject
One recorded top-up, credit or charge.
Show 7 attributesHide attributes
amount_microsintegerAlways present
Signed wallet amount, in millionths of a dollar.
atstring (date-time)Always present
When the entry was recorded.
idstringAlways present
Ledger entry's ID.
kindstringAlways present
Reason for the entry.
period_endstring (date-time)
End of the period covered by a charge. May be omitted.
period_startstring (date-time)
Beginning of the period covered by a charge. May be omitted.
poolstring
Pool associated with the entry. May be omitted.
nextstring
Cursor for before to fetch the next older page. Absent on the last page. May be omitted.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • API key permission: billing history.