Self-service quota and usage snapshot
curl --request GET \
--url https://secureai.hiperai.ai/api/external/usage \
--header 'Authorization: Bearer <token>'import requests
url = "https://secureai.hiperai.ai/api/external/usage"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://secureai.hiperai.ai/api/external/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Facturación, Cuotas & Webhooks
Usage & Quota
Self-service points, budget, and rate-limit snapshot for an API key
GET
/
usage
Self-service quota and usage snapshot
curl --request GET \
--url https://secureai.hiperai.ai/api/external/usage \
--header 'Authorization: Bearer <token>'import requests
url = "https://secureai.hiperai.ai/api/external/usage"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://secureai.hiperai.ai/api/external/usage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Usage & Quota
Return a self-service snapshot of the calling API key’s quota and usage: the billed user’s points bucket, the Usage-by-Model budget when enabled, and the key’s own request limits and rate limits. This is the same data you’d otherwise read from the admin panel, exposed to the key holder.Endpoint
GET /usage
Authentication
Authorization: Bearer sk-your-api-key-here
Request Example
curl -X GET "https://{customer.name}.hiperai.ai/api/external/usage" \
-H "Authorization: Bearer sk-your-api-key-here"
Response
{
"success": true,
"points": {
"remaining": 4188,
"monthly_limit": 5000,
"next_renewal": "2026-08-01T00:00:00.000Z"
},
"usage_by_model": {
"enabled": true,
"dollar_limit": 250,
"current_spend": 61.4,
"remaining_budget": 188.6
},
"api_key": {
"name": "Production integration",
"billing_mode": "user-completions",
"daily": { "used": 120, "limit": 1000, "remaining": 880 },
"monthly": { "used": 3400, "limit": 10000, "remaining": 6600 },
"rate_limit": { "requests_per_minute": 60, "requests_per_hour": 1000 },
"expires_at": null
}
}
Fields
| Field | Description |
|---|---|
points.remaining | Points left in the billed user’s bucket. |
points.monthly_limit | The user’s monthly points allowance. |
points.next_renewal | ISO timestamp of the next points renewal. |
usage_by_model | When the billed user is on the Usage-by-Model billing mode: dollar_limit, current_spend, remaining_budget. Otherwise { "enabled": false }. |
api_key.billing_mode | user-completions or usage-by-model — see Billing Modes. |
api_key.daily / api_key.monthly | The key’s request counters (used, limit, remaining). |
api_key.rate_limit | Per-minute and per-hour request ceilings. |
api_key.expires_at | ISO expiry timestamp, or null if the key never expires. |
Notes
- Values reflect the billed user, which may differ from the key owner when requests use
user_idon-behalf-of billing. - To preview whether a specific request would pass its quota (without spending), use Policy Check and read
checks.quota.
Related
Authorizations
API key authentication using Bearer token format.
Example: Authorization: Bearer sk-your-api-key-here
Response
Points, usage_by_model, and api_key limit snapshot