Get License Availability
curl --request GET \
--url https://secureai.hiperai.ai/api/external/licenses/availability \
--header 'Authorization: Bearer <token>'import requests
url = "https://secureai.hiperai.ai/api/external/licenses/availability"
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/licenses/availability', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"limits": {
"Essential": 1,
"Growth": 0,
"Ultra": 2,
"Early Access": 12
},
"usage": {
"Essential": 1,
"Growth": 5,
"Ultra": 1,
"Early Access": 0
},
"remaining": {
"Essential": 0,
"Growth": 1.7976931348623157e+308,
"Ultra": 1,
"Early Access": 12
}
}{
"success": false,
"error": "Invalid API key",
"message": "The provided API key is invalid or has been revoked",
"request_id": "req-abc123"
}{
"success": false,
"error": "Invalid API key",
"message": "The provided API key is invalid or has been revoked",
"request_id": "req-abc123"
}Facturación, Cuotas & Webhooks
Licenses Availability
Retrieve current license pool limits, usage, and remaining (admin only)
GET
/
licenses
/
availability
Get License Availability
curl --request GET \
--url https://secureai.hiperai.ai/api/external/licenses/availability \
--header 'Authorization: Bearer <token>'import requests
url = "https://secureai.hiperai.ai/api/external/licenses/availability"
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/licenses/availability', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"limits": {
"Essential": 1,
"Growth": 0,
"Ultra": 2,
"Early Access": 12
},
"usage": {
"Essential": 1,
"Growth": 5,
"Ultra": 1,
"Early Access": 0
},
"remaining": {
"Essential": 0,
"Growth": 1.7976931348623157e+308,
"Ultra": 1,
"Early Access": 12
}
}{
"success": false,
"error": "Invalid API key",
"message": "The provided API key is invalid or has been revoked",
"request_id": "req-abc123"
}{
"success": false,
"error": "Invalid API key",
"message": "The provided API key is invalid or has been revoked",
"request_id": "req-abc123"
}Licenses Availability
Retrieve license pool limits, current usage, and remaining licenses for each tier.Endpoint
GET /licenses/availability
Description
Returns the license pool status for all license tiers, including limits, current usage, and remaining capacity. Admin-only endpoint.Authentication
Required: API Key with admin privilegesAuthorization: Bearer sk-your-api-key-here
Request
curl -X GET "https://{customer.name}.hiperai.ai/api/external/licenses/availability" \
-H "Authorization: Bearer sk-your-api-key-here"
Response
Success Response (200)
{
"success": true,
"limits": { "Essential": 1, "Growth": 0, "Ultra": 2, "Early Access": 12 },
"usage": { "Essential": 1, "Growth": 5, "Ultra": 1, "Early Access": 0 },
"remaining": { "Essential": 0, "Growth": Infinity, "Ultra": 1, "Early Access": 12 }
}
Response Fields
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates if the operation was successful |
limits | object | License pool configured limits per tier |
usage | object | Current assigned/used licenses per tier |
remaining | object | Remaining licenses per tier |
Error Responses
401 Unauthorized
{
"success": false,
"error": "Invalid API key",
"message": "The provided API key is invalid or has been revoked"
}
403 Forbidden
{
"success": false,
"error": "Access denied",
"message": "Admin access required"
}
Notes
- Admin-only endpoint
- Remaining may be reported as
Infinitywhen no pool limit is enforced for that tier - Values are organization-wide aggregates
Authorizations
API key authentication using Bearer token format.
Example: Authorization: Bearer sk-your-api-key-here
Response
License availability
Example:
true
Show child attributes
Show child attributes
Example:
{
"Essential": 1,
"Growth": 0,
"Ultra": 2,
"Early Access": 12
}
Show child attributes
Show child attributes
Example:
{
"Essential": 1,
"Growth": 5,
"Ultra": 1,
"Early Access": 0
}
Show child attributes
Show child attributes
Example:
{
"Essential": 0,
"Growth": 1.7976931348623157e+308,
"Ultra": 1,
"Early Access": 12
}

