Get a license entitlement
Retrieve a entitlement for a license by their unique slugs
Authorization
bearerAuth read:licensesAuthorizationBearer <token>
A JWT verified by the proxy in front of this API, or a Kaiten access token (ksh_...) — send either as Authorization: Bearer <token>. The scopes listed on each operation are the ones the token must carry; write:<module> implies read:<module>, and read:* / write:* are wildcards over every module. x-kaiten-scopes lists every scope such a token can carry, including those enforced by a service in front of this API rather than by one of its operations.
In: header
Scope: read:licenses
Path Parameters
licenseSlug*string
entitlementSlug*string
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://app.kaiten.sh/api/licenses/string/entitlements/string"{
"createdAt": "2023-10-01T12:00:00Z",
"createdBy": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "John Doe"
},
"entitlementGroups": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "AI Quotas",
"slug": "ai-quotas"
}
],
"entitlementName": "Premium Support",
"entitlementSlug": "premium-support",
"entitlementType": "NUMBER",
"licenseId": "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6",
"licenseSlug": "enterprise-license",
"limitCapExceededOveragePercent": 10,
"updatedAt": "2023-10-02T12:00:00Z",
"updatedBy": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "John Doe"
},
"value": {
"event_count": 2,
"type": "number",
"value": 42.5
}
}{
"code": "License.NotFound",
"detail": "license not found",
"errorId": "3f6b1a2c-7c1e-4d0b-9d5f-2b0a1c4e8d31",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "/api/licenses/enterprise",
"status": 404,
"title": "Not Found",
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4"
}{
"code": "License.NotFound",
"detail": "license not found",
"errorId": "3f6b1a2c-7c1e-4d0b-9d5f-2b0a1c4e8d31",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "/api/licenses/enterprise",
"status": 404,
"title": "Not Found",
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4"
}{
"code": "License.NotFound",
"detail": "license not found",
"errorId": "3f6b1a2c-7c1e-4d0b-9d5f-2b0a1c4e8d31",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "/api/licenses/enterprise",
"status": 404,
"title": "Not Found",
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4"
}{
"code": "License.NotFound",
"detail": "license not found",
"errorId": "3f6b1a2c-7c1e-4d0b-9d5f-2b0a1c4e8d31",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "/api/licenses/enterprise",
"status": 404,
"title": "Not Found",
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4"
}{
"code": "License.NotFound",
"detail": "license not found",
"errorId": "3f6b1a2c-7c1e-4d0b-9d5f-2b0a1c4e8d31",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "/api/licenses/enterprise",
"status": 404,
"title": "Not Found",
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4"
}