Skip to main content
GET
Get credit usage history

Usage notes

from and to filter the ledger timestamp. service is an exact raw service_type, not a closed enum. Current values include product_import, pdf_extraction, ai_field, ai_field_bulk, product_search, product_enrich, image_gallery_max, ai_image_generation, ai_image_generation_flash, and richtext_alt_text. total_used is calculated over the full filtered period, not only the current page. The response field named table_id is populated from transaction metadata job_id. Depending on the service, it can identify a table, enhancement job, Search job, or Enrich job.
In Python SDK 0.2, pass the reserved query name with client.credits.usage(**{"from": "2026-08-01", "to": "2026-08-31"}). The convenience name from_ is not translated to from.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:25
Required range: 1 <= x <= 100
from
string<date>

Start date filter

to
string<date>

End date filter

service
string

Exact raw service type stored in the credit ledger. The API does not restrict this to a fixed enum.

Response

Credit usage history

data
object[]
required
pagination
object
required
total_used
number
required

Total credits used in the filtered period