Retrieve Credits Status API
Retrieve the user's current balance of credits, including balance details, currency, expiration date, and account status.
Last updated
Retrieve the user's current balance of credits, including balance details, currency, expiration date, and account status.
Last updated
Endpoint: GET
Purpose: Retrieve the API usage details for all requests.
Parameters:
key (string, required, query): Your unique API key.
Usage Example:
Expected Response
A successful response provides a JSON object with the following fields:
balance: Remaining balance in decimal format.
currency: Currency symbol for the balance.
credits: Available credit count.
expiratioDate: Expiration date of the credits (ISO 8601 format).
status: Current account status (e.g., "Active").
Example Response
This endpoint provides an overview of the user’s credit status, supporting effective balance tracking and account management.