Credits Usage API
The Credits Usage API allows you to obtain real-time information on used credits, applicable to both one-off and subscription credits. This endpoint is restricted to organization admins for an organization and cannot be accessed by organization members.
Documentation
API Endpoint
LANGUAGE
Python
PHP
Java
Node
Ruby
$ pip install requests
API Response
| Field | Type | Requirement | Description |
|---|---|---|---|
| apiKey | String | Mandatory | API key provided in the input whose usage is required |
| userStatus | String | Mandatory | status of user. Possible values are:
(1) active
(2) inactive
(3) deleted |
| subActive | Boolean | Optional | Whether subscriptions credits are consumable or not |
| subStatus | String | Optional | Status of the subscription credits. Possible values are:
(1) active
(2) overdue
(3) cancelled
(4) deactivated |
| subAllowedCredits | Integer | Optional | Allowed credits limit of subscription credits |
| subUsedCredits | Integer | Optional | Used credits from subscription credits |
| subSurchargeStatus | String | Optional | Status of Subscription Surcharge. Possible values are:
(1) none
(2) payment_added
(3) payment_cleared |
| subSurchargeAllowedCredits | Integer | Optional | Surcharge allowed credits for susbcription |
| subSurchargeUsedCredits | Integer | Optional | Surcharge used credits from for susbcription |
| subSurchargeAllowed | Boolean | Optional | Whether surcharge credits are allowed for subscription or not |
| oneOffCreditsActive | Boolean | Mandatory | Whether one-off credits are consumable or not |
| oneOffAllowedCredits | Integer | Mandatory | Allowed credits limit of one-off credits |
| oneOffUsedCredits | Integer | Mandatory | Used credits from one-off credits |
HTTP Error Codes
| HTTP Status | Reasons |
|---|---|
| 403 | You need to be organization admin to access this endpoint. |