Overview
Check your account balance, available credits, points, and low balance alert settings.Request
Headers
| Header | Type | Required | Description |
|---|---|---|---|
x-api-key | string | Yes | Your API key for authentication |
Example Request
Response
Response Fields
| Field | Type | Description |
|---|---|---|
code | integer | Response status code (200 for success) |
message | string | Response message |
data | object | Account balance data |
data.account_id | integer | Your account identifier |
data.balance_usd | float | Current balance in USD |
data.available_credits | integer | Available credits for API usage |
data.available_points | integer | Available points |
data.alert_threshold | integer | Low balance alert threshold in USD |
data.low_balance_alert | boolean | Whether low balance alert is triggered |
data.updated_at | string | Last update timestamp (ISO 8601 format) |
Example Response
Understanding Your Balance
- balance_usd: Your current account balance in US dollars
- available_credits: Credits that can be used for API operations
- available_points: Bonus points or promotional credits
- alert_threshold: You’ll receive alerts when balance falls below this amount
- low_balance_alert: Indicates if your balance is currently below the threshold
Notes
- Check your balance regularly to ensure uninterrupted service
- Set up webhook notifications for low balance alerts
- Credits are deducted based on the API operations you perform
Authorizations
API key for authentication
Response
200
Balance retrieved successfully