Skip to main content
GET
List credit ledger entries

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

entry_kind
enum<string> | null

The kind of a credit ledger entry.

Available options:
grant,
expiry,
pack_purchase,
charge,
refund,
referral,
adjustment
entry_kind__in
enum<string>[] | null

Only entries of any of these kinds. Repeat the parameter for each kind. Use this rather than several requests when a surface shows a mix — 'where did my credits come from', say, which wants every kind except usage charges.

Maximum array length: 20

The kind of a credit ledger entry.

Available options:
grant,
expiry,
pack_purchase,
charge,
refund,
referral,
adjustment
start_time
string<date-time> | null
end_time
string<date-time> | null
limit
integer
default:10

The number of items to return.

Required range: 1 <= x <= 100
order_by
enum<string>
default:occurred_at
Available options:
id,
occurred_at,
created_at,
updated_at
order_direction
enum<string>
default:desc
Available options:
asc,
desc
cursor
string | null

Set the cursor to the next or previous page. You can get the cursor from the previous page's response.

Response

Successful Response

data
CreditLedgerEntrySchema · object[]

The list of ResponseItems.

next_page_cursor
string | null

The cursor to the next page. If there are no more pages, this is None.

previous_page_cursor
string | null

The cursor to the previous page. If there are no previous pages, this is None.