List ledger entries | Runledger API

{
  "object": "string",
  "data": [
    {
      "id": "le_1qA5sD8fGh",
      "object": "string",
      "customer": "string",
      "type": "grant",
      "status": "pending",
      "amount": "-40",
      "effective_at": "2024-01-15T09:30:00Z",
      "description": "Chat resolution, conv_4821",
      "livemode": true,
      "created_at": "2024-01-15T09:30:00Z",
      "credit_type": "string",
      "currency": "string",
      "posted_balance_after": "1260",
      "posted_at": "2024-01-15T09:30:00Z",
      "archived_at": "2024-01-15T09:30:00Z",
      "credit_grant": "string",
      "hold": "string",
      "event": "string",
      "outcome_charge": "string",
      "reversal": "string",
      "invoice": "string",
      "pool": "string",
      "member_id": "string",
      "team_id": "string",
      "corrects": "string"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

A customer’s statement: every movement behind their balances, newest first. Entries are never edited. A pending entry becomes posted or archived; a correction is a new entry that links to the one it corrects.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Query parameters

customer_idstringRequired

The customer whose entries to list.

credit_typestringOptional

Only entries in this credit type (ID or key).

poolstringOptional

Only entries in this pool.

member_idstringOptional

Only entries for this member.

team_idstringOptional

Only entries for this team.

currencystringOptional

Only entries in this currency.

typeenumOptional

Only entries of this type.

statusenumOptional

Only entries with this status.

Allowed values:

outcome_chargestringOptional

Only entries for this outcome charge.

holdstringOptional

Only entries for this hold.

effective_afterdatetimeOptional

Only entries effective at or after this time.

effective_beforedatetimeOptional

Only entries effective before this time.

limitintegerOptional1-100Defaults to 20

Maximum number of objects to return, from 1 to 100.

cursorstringOptional

The next_cursor from the previous page.

Response

A page of ledger entries.

object"list"

datalist of objects

has_moreboolean

next_cursorstringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error