Overview
The Credit Balance endpoint returns how many credits you have remaining in the current billing period, along with your plan tier and the date when credits next reset. Use this to monitor consumption and plan API usage.Authentication
Requires a valid API key. No special permission scope is needed beyond a valid key.Key Features
- Real-Time Balance: Current credit count updated after every API call
- Reset Date: Know exactly when credits refresh
- Plan Awareness: Confirm which plan tier is active
- No Credit Cost: This endpoint is free to use
Example Response
Response Fields
| Field | Type | Description |
|---|---|---|
balance | integer | Number of credits remaining in the current billing period |
subscription_plan | string | Active plan: FREE, PRO, ENTERPRISE, or CUSTOM |
next_reset | string | ISO 8601 date when the credit balance resets |
Credit Usage
This endpoint is free and does not consume credits.Related Endpoints
- Get Credit Usage to see a history of credit consumption
- Get Credit Breakdown to see usage grouped by feature
- Get Organisation to see subscription and account details