Skip to main content
GET
List credit-ledger events

Authorizations

X-Api-Key
string
header
required

Your team API key (starts with al_live_).

Headers

Aurous-Version
string

Optional API version pin (YYYY-MM-DD). Defaults to your team's pinned version, or the system default 2026-07-16 for unauthenticated requests.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-07-16"

Query Parameters

starting_after
string

Cursor — opaque uev_* id; returns events STRICTLY OLDER than this.

Example:

"uev_01HXMQ7Z3K8Y2NABCDEFGHJKMN"

limit
number

Items per page (1–100, default 20).

Example:

20

type
enum<string>

Filter by event type.

Available options:
hold,
release,
charge,
refund,
topup,
adjustment

Response

Cursor-paginated list of usage events.

object
enum<string>
required

Discriminator

Available options:
list
Example:

"list"

data
object[]
required

Array of UsageEventResponse items

has_more
boolean
required

True when the next page exists

Example:

true

next_cursor
object | null

Pass as ?starting_after= on the next request. null when has_more is false.

Example:

"img_01HXMQ7Z3K8Y2ABCDEFGHJKM"