REST Resource: projects.locations.licenseConfigs

Resource: LicenseConfig

Information about users' licenses.

JSON representation 
{
  "name": string,
  "licenseCount": string,
  "subscriptionTier": enum (SubscriptionTier),
  "state": enum (State),
  "autoRenew": boolean,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "subscriptionTerm": enum (SubscriptionTerm),
  "freeTrial": boolean,
  "geminiBundle": boolean,
  "earlyTerminated": boolean,
  "earlyTerminationDate": {
    object (Date)
  },
  "lastUserUpdateTime": string
}
Fields
name

string

Immutable. Identifier. The fully qualified resource name of the license config. Format: projects/{project}/locations/{location}/licenseConfigs/{licenseConfig}
licenseCount

string (int64 format)

Required. Number of licenses purchased.
subscriptionTier

enum (SubscriptionTier)

Required. Subscription tier information for the license config.
state

enum (State)

Output only. The state of the license config.
autoRenew

boolean

Optional. Whether the license config should be auto renewed when it reaches the end date.
startDate

object (Date)

Required. The start date.
endDate

object (Date)

Optional. The planed end date.
subscriptionTerm

enum (SubscriptionTerm)

Required. Subscription term.
freeTrial

boolean

Optional. Whether the license config is for free trial.
geminiBundle

boolean

Output only. Whether the license config is for Gemini bundle.
earlyTerminated

boolean

Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
earlyTerminationDate

object (Date)

Output only. The date when the subscription is terminated earlier than the expiration date.
lastUserUpdateTime

string (Timestamp format)

Optional. timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike updateTime, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.).

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

State

License config state enumeration.

Enums
STATE_UNSPECIFIED Default value. The license config does not exist.
ACTIVE The license config is effective and being used.
EXPIRED The license config has expired.
NOT_STARTED The license config has not started yet, and its start date is in the future.
WITHDRAWN This is when a sub license config has returned all its seats back to BillingAccountLicenseConfig that it belongs to. Similar to EXPIRED.
DEACTIVATING The license config is in a grace period. Its subscription has ended, either through early termination or by reaching its end date, but the customer keeps access for a limited time. It becomes EXPIRED when the grace period ends.

SubscriptionTerm

Subscription term.

Enums
SUBSCRIPTION_TERM_UNSPECIFIED Default value, do not use.
SUBSCRIPTION_TERM_ONE_MONTH 1 month.
SUBSCRIPTION_TERM_ONE_YEAR 1 year.
SUBSCRIPTION_TERM_THREE_YEARS 3 years.
SUBSCRIPTION_TERM_CUSTOM Custom term. Must set the endDate.

Methods

create

 Creates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses.

get

 Gets a LicenseConfig.

list

 Lists all the LicenseConfigs associated with the project.

patch

 Updates the LicenseConfig