project_gitlab_subscriptions_preview_billable_user_change

Gets or lists a project_gitlab_subscriptions_preview_billable_user_change resource.

Overview

Name	project_gitlab_subscriptions_preview_billable_user_change
Type	Resource
Id	gitlab.admin.project_gitlab_subscriptions_preview_billable_user_change

Fields

The following fields are returned by SELECT queries:

get

GraphQL response envelope

Name	Datatype	Description
new_billable_user_count	integer	Total number of billable users after change.
seats_in_subscription	integer	Number of seats in subscription.
will_increase_overage	boolean	If the group will have an increased overage after change.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	full_path, role, host	add_group_id, member_role_id	Preview Billable User Changes Generated from the GitLab GraphQL schema field Project.gitlabSubscriptionsPreviewBillableUserChange (PreviewBillableUserChange).

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
full_path	string	Full path of the project, for example gitlab-org/gitlab
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)
role	string	Role of users being added to group.
add_group_id	integer	Group ID to add.
member_role_id	integer	Custom role assigned to the users.

SELECT examples

get

Preview Billable User Changes Generated from the GitLab GraphQL schema field Project.gitlabSubscriptionsPreviewBillableUserChange (PreviewBillableUserChange).

SELECT
new_billable_user_count,
seats_in_subscription,
will_increase_overage
FROM gitlab.admin.project_gitlab_subscriptions_preview_billable_user_change
WHERE full_path = '{{ full_path }}' -- required
AND role = '{{ role }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND add_group_id = '{{ add_group_id }}'
AND member_role_id = '{{ member_role_id }}'
;