Skip to main content

GET /credits/balance

This endpoint returns the authenticated user’s current credit balance and usage statistics. Requires session-based authentication (JWT access token).
For third-party integrations: Use GET /credits/balance/api with API Key authentication instead.

Response

number
The user’s current available credit balance.
number
Total credits purchased over the account lifetime.
number
Total credits used over the account lifetime.
array
Array of recent credit transactions.

GET /credits/balance/api

This endpoint returns the authenticated user’s current credit balance using API Key authentication. Ideal for third-party integrations and external applications.

Authentication

Requires API Key authentication. Include your API key in the Authorization header:

Response

Same as /credits/balance above.