current_license

Gets or lists a current_license resource.

Overview

Name	current_license
Type	Resource
Id	gitlab.metadata.current_license

Fields

The following fields are returned by SELECT queries:

get

GraphQL response envelope

Name	Datatype	Description
id	string	ID of the license extracted from the license data.
name	string	Name of the licensee.
activated_at	string	Date when the license was activated.
billable_users_count	integer	Number of billable users on the system.
block_changes_at	string	Date when licensed features will be blocked.
company	string	Company of the licensee.
created_at	string	Date when the license was added.
email	string	Email of the licensee.
expires_at	string	Date when the license expires.
has_gitlab_credits_add_on	boolean	Whether the license has an active GitLab Credits add-on.
last_sync	string	Date when the license was last synced.
maximum_user_count	integer	Highest number of billable users on the system during the term of the current license.
plan	string	Name of the subscription plan.
starts_at	string	Date when the license started.
trial	boolean	Indicates if the license is a trial.
type	string	Type of the license.
users_in_license_count	integer	Number of paid users in the license.
users_over_license_count	integer	Number of users over the paid users in the license.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	host		Fields related to the current license. Generated from the GitLab GraphQL schema field Query.currentLicense (CurrentLicense).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
host	string	GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST)

SELECT examples

get

Fields related to the current license. Generated from the GitLab GraphQL schema field Query.currentLicense (CurrentLicense).

SELECT
id,
name,
activated_at,
billable_users_count,
block_changes_at,
company,
created_at,
email,
expires_at,
has_gitlab_credits_add_on,
last_sync,
maximum_user_count,
plan,
starts_at,
trial,
type,
users_in_license_count,
users_over_license_count
FROM gitlab.metadata.current_license
WHERE host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;