Skip to main content
GET
/
api
/
v1
/
credits
/
ledger
Get a list of credit ledger events
curl --request GET \
  --url https://api.example.com/api/v1/credits/ledger \
  --header 'X-API-KEY: <api-key>'
{
  "data": [
    {
      "timestamp": "2024-01-15T10:30:00.000Z",
      "eventType": "CREDITS_GRANTED",
      "customerId": "customer-123",
      "resourceId": null,
      "eventId": null,
      "featureId": null,
      "amount": 1000,
      "creditGrantId": "cred-grant-abc123",
      "creditCurrencyId": "credits"
    }
  ],
  "pagination": {
    "next": "c9b0a382-5b7d-4d32-9f62-8c4e1a7b3d9f",
    "prev": "a1d4e8f2-6c3b-4a9e-b5f7-2d8c9e0f1a3b"
  }
}

Authorizations

​
X-API-KEY
string
header
required

Server API Key

Query Parameters

​
after
string

Return items that come after this cursor

Maximum string length: 255
​
before
string

Return items that come before this cursor

Maximum string length: 255
​
limit
integer
default:20

Maximum number of items to return

Required range: 1 <= x <= 100
​
customerId
string
required

Filter by customer ID (required)

Maximum string length: 255
​
resourceId
string

Filter by resource ID

Maximum string length: 255
​
currencyId
string

Filter by currency ID

Maximum string length: 255

Response

A paginated list of credit ledger event objects.

Response list object

​
data
CreditLedgerEvent · object[]
required
​
pagination
object
required

Pagination metadata including cursors for navigating through results