gitlab-foss/doc/subscriptions/self_managed/_index.md

stage, group, info, description, title

stage	group	info	description	title
Fulfillment	Subscription Management	To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments	Billable users, renewal and upgrade info.	GitLab Self-Managed subscription

{{< details >}}

• Tier: Premium, Ultimate
• Offering: GitLab Self-Managed

{{< /details >}}

After you subscribe to GitLab, you can manage the details of your self-managed subscription. If you experience any issues, see the troubleshooting page.

How GitLab bills for users

A GitLab Self-Managed subscription uses a hybrid model. You pay for a subscription according to the maximum number of users enabled during the subscription period.

For instances that are not offline or on a closed network, the maximum number of simultaneous users in the GitLab Self-Managed instance is checked each quarter.

If an instance is unable to generate a quarterly usage report, the existing true up model is used. Prorated charges are not possible without a quarterly usage report.

Users in subscription

The number of users in subscription represents the number of users included in your current license, based on what you've paid for. This number remains the same throughout your subscription period unless you purchase more seats.

Maximum users

The number of maximum users reflects the highest number of billable users on your system for the current license period.

Users over subscription

A GitLab subscription is valid for a specific number of seats. The number of users over subscription shows how many users are in excess of the number allowed by the subscription, in the current subscription period.

Calculated as Maximum users - Users in subscription for the current license term. For example, you purchase a subscription for 10 users.

Event	Billable users	Maximum users
Ten users occupy all 10 seats.	10	10
Two new users join.	12	12
Three users leave and their accounts are blocked.	9	12
Four new users join.	13	13

Users over subscription = 13 - 10 (Maximum users - users in license)

The users over subscription value is always zero for trial license.

If users over subscription value is above zero, then you have more users in your GitLab instance than you are licensed for. You must pay for the additional users before or at the time of renewal. This is called the "true up" process. If you do not do this, your license key does not work.

To view the number of users over subscription, go to the Admin area.

View users

View the lists of users in your instance:

1. On the left sidebar, at the bottom, select Admin.
2. Select Users.

Select a user to view their account information.

Check daily and historical billable users

Prerequisites:

• You must be an administrator.

You can get a list of daily and historical billable users in your GitLab instance:

1. Start a Rails console session.

2. Count the number of users in the instance:

   User.billable.count
   

3. Get the historical maximum number of users on the instance from the past year:

   ::HistoricalData.max_historical_user_count(from: 1.year.ago.beginning_of_day, to: Time.current.end_of_day)
   

Update daily and historical billable users

Prerequisites:

• You must be an administrator.

You can trigger a manual update of the daily and historical billable users in your GitLab instance.

1. Start a Rails console session.

2. Force an update of the daily billable users:

   identifier = Analytics::UsageTrends::Measurement.identifiers[:billable_users]
   ::Analytics::UsageTrends::CounterJobWorker.new.perform(identifier, User.minimum(:id), User.maximum(:id), Time.zone.now)
   

3. Force an update of the historical max billable users:

   ::HistoricalDataWorker.new.perform
   

Manage users and subscription seats

Managing the number of users against the number of subscription seats can be difficult:

• If LDAP is integrated with GitLab, anyone in the configured domain can sign up for a GitLab account. This can result in an unexpected bill at time of renewal.
• If sign-up is turned on in your instance, anyone who can access the instance can sign up for an account.

GitLab has several features to help you manage the number of users. You can:

• Require administrator approval for new sign ups.
• Automatically block new users, either through LDAP or OmniAuth.
• Limit the number of billable users who can sign up or be added to a subscription without administrator approval.
• Disable new sign-ups, and instead manage new users manually.
• View a breakdown of users by role in the Users statistics page.

To increase the number of users covered by your license, buy seats for your subscription during the subscription period. The cost of seats added during the subscription period is prorated from the date of purchase through to the end of the subscription period. You can continue to add users even if you reach the number of users in license count. GitLab bills you for the overage.

If your subscription was activated with an activation code, the additional seats are reflected in your instance immediately. If you're using a license file, you receive an updated file. To add the seats, add the license file to your instance.

Export your license usage

Prerequisites:

• You must be an administrator.

You can export your license usage into a CSV file.

This file contains the information GitLab uses to manually process quarterly reconciliations and renewals. If your instance is firewalled or an offline environment, you must provide GitLab with this information.

{{< alert type="warning" >}}

Do not open the license usage file. If you open the file, failures might occur when you submit your license usage data.

{{< /alert >}}

1. On the left sidebar, at the bottom, select Admin.
2. Select Subscription.
3. In the upper-right corner, select Export license usage file.

License usage file contents

The license usage file includes the following information:

• License key
• Licensee email
• License start date (UTC)
• License end date (UTC)
• Company
• Timestamp the file was generated at and exported (UTC)
• Table of historical user counts for each day in the period:
  • Timestamp the count was recorded (UTC)
  • Billable user count

{{< alert type="note" >}}

A custom format is used for dates and times in CSV files.

{{< /alert >}}

Review your account

You should regularly review your billing account settings and purchasing information.

To review your billing account settings:

1. Sign in to the Customers Portal.
2. Select Billing account settings.
3. Verify or update:
   • Under Payment methods, the credit card on file.
   • Under Company information, the subscription and billing contact details.
4. Save any changes.

You should also regularly review your user accounts to make sure that you are only renewing for the correct number of active billable users. Inactive user accounts:

• Might count as billable users. You pay more than you should if you renew inactive user accounts.
• Can be a security risk. A regular review helps reduce this risk.

For more information, see the documentation on:

• User statistics.
• Managing users and subscription seats.

Add or change the contacts for your subscription

Contacts can manage subscriptions and billing account settings.

For information about how to transfer ownership of the Customers Portal account to another person, see Change profile owner information.

To add another contact for your subscription, see Add a billing account manager.

Storage

The amount of storage and transfer for GitLab Self-Managed instances has no application limits. Administrators are responsible for the underlying infrastructure costs and can set repository size limits.