Skip to content

Retrieve a license

GET
/api/v4/license/{id}

Retrieves information about a specified license.

id
required
integer

ID of the GitLab license

OK

Media type application/json
object
id
integer format: int64
plan
string
created_at
string format: date-time
starts_at
string format: date
expires_at
string format: date
historical_max
integer
maximum_user_count
integer
licensee
object
add_ons
object
expired
boolean
overage

Difference between the number of billable users and the number of licensed users. Calculated differently depending on whether the license has expired or not.

integer
user_limit
integer
active_users
integer
Example
{
"id": 1,
"plan": "silver",
"created_at": "2012-05-28T04:42:42-07:00",
"starts_at": "2018-01-27",
"expires_at": "2022-01-27",
"historical_max": 300,
"maximum_user_count": 300,
"licensee": {
"Name": "John Doe1"
},
"add_ons": {
"GitLab_FileLocks": 1,
"GitLab_Auditor_User": 1
},
"overage": 200,
"user_limit": 200
}

Bad Request

Unauthorized

Forbidden

Not Found