Skip to main content
GET
List prepaid credit ledger entries

Authorizations

x-api-key
string
header
required

Query Parameters

cursor
string<date-time>

Return entries created before this timestamp.

cursor_id
string

Tiebreaker for cursor. Entries written in the same transaction share an identical created_at, so ordering by timestamp alone is not total and a page boundary that splits them can drop a row. When supplied alongside cursor, entries are returned strictly before (cursor, cursor_id) in (created_at, id) order. Pass the id of the last entry on the previous page. Ignored unless cursor is also present.

Example:

"34o8dS2h9c7n1V8qLpY2Zx6TwUa"

limit
integer<int32>
default:20

Maximum number of entries to return.

Required range: 1 <= x <= 100
type
enum<string>

Optional ledger entry type filter.

Available options:
purchase,
bonus,
deduction,
refund,
adjustment

Response

Paginated credit ledger entries

entries
object[]
required
has_more
boolean
required
Example:

false