Skip to content

Current license status and entitlements

GET
/v1/console/license
curl --request GET \
--url https://example.com/v1/console/license \
--header 'Authorization: Bearer <token>'

Returns the current license status and the entitlements it grants.

OK

Media type application/json
object
expires_at
string format: date-time
holder
string
licensee
string
max_users
integer
plan
string
support_tier
string
valid
boolean
Example generated
{
"expires_at": "2026-04-15T12:00:00Z",
"holder": "example",
"licensee": "example",
"max_users": 1,
"plan": "example",
"support_tier": "example",
"valid": true
}

Bad request

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Unauthenticated

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Forbidden

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Not found

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Conflict / setup required

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}

Rate limited

Media type application/json
object
error
required
object
code
required
string
message
required
string
Example generated
{
"error": {
"code": "example",
"message": "example"
}
}