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
}
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.

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.

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.

Methods

create

Creates a LicenseConfig

get

Gets a LicenseConfig.

patch

Updates the LicenseConfig