License

Returns HQ's licence summary.

GEThttps://api.example.com/api/v1/licence-summary

Response

200default

Successfully returns licence response.

Body

application/json

is_community*boolean

Is true when the licence is a community one, false otherwise.

Request

JavaScriptCurlPython

const response = await fetch('https://api.example.com/api/v1/licence-summary', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "is_community": false
}

Returns HQ's licence.

GEThttps://api.example.com/api/v1/licence

Response

200default

Successfully returns licence response.

Body

application/json

expires_atstring (date-time)

Is set to the moment HQ no longer considers this licence valid. Will be omitted for licences that do not expire.

tier*LicenceTier (enum)

Enumerates licence tiers.

communityenterprise

Request

JavaScriptCurlPython

const response = await fetch('https://api.example.com/api/v1/licence', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200default

{
  "expires_at": "2025-01-17T13:57:59.159Z",
  "tier": "community"
}