Retrieve a ledger entry | Runledger API

{
  "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"
}

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.

Path parameters

ledger_entry_idstringRequired

The ledger entry ID (le_...).

Response

The ledger entry.

idstring

object"ledger_entry"

customerstring

typeenum

grant, grant_expired and grant_voided move credits in and out. hold reserves. usage and outcome charge. outcome_reversed gives back. invoiced moves a postpaid period’s charges onto its invoice.

statusenum

pending counts as held. posted is final. archived is a pending entry that was released and never posted.

Allowed values:

amountstring

Signed decimal string. Negative entries reduce the balance.

effective_atdatetime

Business time, which may be in the past for backdated events.

descriptionstring

livemodeboolean

created_atdatetime

credit_typestringOptional

currencystringOptional

posted_balance_afterstringOptional

The posted balance after this entry. Present on posted entries.

posted_atdatetimeOptional

archived_atdatetimeOptional

credit_grantstringOptional

holdstringOptional

eventstringOptional

outcome_chargestringOptional

reversalstringOptional

invoicestringOptional

poolstringOptional

The pool the entry moved credits in.

member_idstringOptional

team_idstringOptional

correctsstringOptional

The entry this one corrects, if it is a correction.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error