Overview
The Credit Usage endpoint returns individual credit consumption events over a specified time window. Each record shows which feature consumed credits, how many were spent, and when. Use this for auditing, billing reconciliation, and tracking consumption trends.Authentication
Requires a valid API key. No special permission scope is needed beyond a valid key.Key Features
- Detailed History: Per-event credit consumption records
- Configurable Window: Look back 1 to 365 days
- Paginated: Handle large usage histories with limit and offset
- No Credit Cost: This endpoint is free to use
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
days | integer | 30 | Number of days to look back (1-365) |
limit | integer | 50 | Number of records per page (1-500) |
offset | integer | 0 | Number of records to skip for pagination |
Example Response
Response Fields
Each record in therecords array includes:
| Field | Type | Description |
|---|---|---|
id | string | Unique usage record identifier |
feature | string | Feature that consumed credits (e.g., search_create, profile_enrich) |
credits | integer | Number of credits consumed |
description | string | Human-readable description of the usage event |
timestamp | string | ISO 8601 date when the credits were consumed |
Credit Usage
This endpoint is free and does not consume credits.Related Endpoints
- Get Credit Balance to check your remaining credits
- Get Credit Breakdown to see usage grouped by feature