List credit grants

GET

https://api.runledger.co/v1/credit_grants

GET

/v1/credit_grants

curl https://api.runledger.co/v1/credit_grants \
     -H "Authorization: Bearer <api_key>"

{
  "object": "string",
  "data": [
    {
      "id": "cg_6tY9pZ3nVb",
      "object": "string",
      "customer": "string",
      "credit_type": "string",
      "amount": "10000",
      "remaining": "8700",
      "category": "paid",
      "priority": 1,
      "effective_at": "2024-01-15T09:30:00Z",
      "status": "scheduled",
      "source": "api",
      "metadata": {},
      "livemode": true,
      "created_at": "2024-01-15T09:30:00Z",
      "cost_basis": {
        "amount_decimal": "0.042",
        "currency": "usd"
      },
      "expires_at": "2024-01-15T09:30:00Z",
      "source_id": "string",
      "pool": "purchased",
      "allowance": "string",
      "actor": {
        "type": "user",
        "id": "usr_4tN8vB2cXk",
        "name": "Claude Code",
        "on_behalf_of": "usr_4tN8vB2cXk",
        "client": "claude-code"
      },
      "voided_at": "2024-01-15T09:30:00Z",
      "void_reason": "string",
      "voided_by": {
        "type": "user",
        "id": "usr_4tN8vB2cXk",
        "name": "Claude Code",
        "on_behalf_of": "usr_4tN8vB2cXk",
        "client": "claude-code"
      }
    }
  ],
  "has_more": true,
  "next_cursor": "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.

Query parameters

customer_idstringOptional

Only objects belonging to this customer.

credit_typestringOptional

Only grants of this credit type (ID or key).

statusenumOptional

Only grants with this status.

Allowed values:

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 grants.

object"list"

datalist of objects

has_moreboolean

next_cursorstringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

500

Internal Server Error