Skip to main content
GET
/
v1
/
usage
/
events
List credit-ledger events
curl --request GET \
  --url https://api.example.com/v1/usage/events \
  --header 'X-Api-Key: <api-key>'
{
  "object": "list",
  "data": [
    {
      "id": "uev_01HXMQ7Z3K8Y2NABCDEFGHJKMN",
      "object": "usage_event",
      "type": "topup",
      "amount": 2,
      "currency": "credit",
      "created_at": "2026-05-04T01:00:00Z",
      "generation_id": "img_01HXMQ7Z3K8Y2NABCDEFGHJKMN",
      "hold_id": "hold_01HXMQ7Z3K8Y2NABCDEFGHJKMN",
      "description": "Stripe top-up"
    }
  ],
  "has_more": true,
  "next_cursor": "img_01HXMQ7Z3K8Y2ABCDEFGHJKM"
}

Documentation Index

Fetch the complete documentation index at: https://docs.aurous-labs.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-Api-Key
string
header
required

Your team API key (starts with al_live_ — legacy keys may start with og_).

Headers

​
Aurous-Version
string

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

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

"2026-05-15"

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

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

Example:

"img_01HXMQ7Z3K8Y2ABCDEFGHJKM"