Skip to main content

History

Get credit transaction history including purchases, deductions, and adjustments with page-based pagination.

GET/v1/credits/history

Response

Response fields

itemsarrayArray of credit transaction records.
items[].idstringTransaction UUID.
items[].amountnumberCredit amount. Negative for deductions, positive for purchases.
items[].typestringTransaction type: consumption, purchase, bonus, or adjustment.
items[].descriptionstringHuman-readable description of the transaction.
items[].operation_typestringOperation that triggered the transaction (e.g. extraction, manual).
items[].created_atstringISO 8601 creation timestamp.
totalintegerTotal number of transactions.
pageintegerCurrent page number.
limitintegerItems per page.

Response

{
  "items": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "amount": -70,
      "type": "consumption",
      "description": "Extraction: doc_3j7x9p2q",
      "operation_type": "extraction",
      "created_at": "2024-09-14T10:32:00.000Z"
    }
  ],
  "total": 482,
  "page": 1,
  "limit": 20
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.