Loading
Loading
Retrieve real-time credit usage information for both one-off and subscription credits. This endpoint is restricted to organization admins and cannot be accessed by organization members.
The Credits Usage API returns a detailed breakdown of your organization's credit consumption, including subscription credits, surcharge credits, and one-off credits.
Pass your API key as the apiKey parameter in every request.
This is version v1.0 of the API.
A successful request returns a 200 OK response with a JSON object containing the credit usage data. See the response preview on the right for the full JSON structure.
apiKeyAPI key provided in the request whose usage is required.
userStatusStatus of the user account. Possible values: active, inactive, deleted.
subActiveWhether subscription credits are consumable.
subStatusStatus of the subscription credits. Possible values: active, overdue, cancelled, deactivated.
subAllowedCreditsAllowed credits limit of the subscription.
subUsedCreditsUsed credits from the subscription.
subSurchargeStatusStatus of subscription surcharge. Possible values: none, payment_added, payment_cleared.
subSurchargeAllowedCreditsSurcharge allowed credits for the subscription.
subSurchargeUsedCreditsSurcharge used credits for the subscription.
subSurchargeAllowedWhether surcharge credits are allowed for the subscription.
oneOffCreditsActiveWhether one-off credits are consumable.
oneOffAllowedCreditsAllowed credits limit of one-off credits.
oneOffUsedCreditsUsed credits from one-off credits.
The API uses standard HTTP status codes to indicate the success or failure of requests. For common status codes like 429 (Too Many Requests), refer to the general API documentation.
You need to be organization admin to access this endpoint.