REST Resource: projects.locations.licenseConfigs

Resource: LicenseConfig
- JSON representation
SubscriptionTier
State
SubscriptionTerm
Methods

Resource: LicenseConfig

Information about users' licenses.

JSON representation

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 }

 { 
 "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.

SubscriptionTier

Subscription tier information.

Enums
`SUBSCRIPTION_TIER_UNSPECIFIED`	Default value.
`SUBSCRIPTION_TIER_SEARCH`	Search tier. Search tier can access VAIS search features and NotebookLM features.
`SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT`	Search + assistant tier. Search + assistant tier can access VAIS search features, NotebookLM features and assistant features.
`SUBSCRIPTION_TIER_NOTEBOOK_LM`	NotebookLM tier. NotebookLM is a subscription tier can only access NotebookLM features.
`SUBSCRIPTION_TIER_FRONTLINE_WORKER`	Frontline worker tier.
`SUBSCRIPTION_TIER_AGENTSPACE_STARTER`	Agentspace Starter tier.
`SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS`	Agentspace Business tier.
`SUBSCRIPTION_TIER_ENTERPRISE`	Enterprise tier.
`SUBSCRIPTION_TIER_EDU`	EDU tier.
`SUBSCRIPTION_TIER_EDU_PRO`	EDU Pro tier.
`SUBSCRIPTION_TIER_EDU_EMERGING`	EDU emerging market tier.
`SUBSCRIPTION_TIER_EDU_PRO_EMERGING`	EDU Pro emerging market tier.

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`

REST Resource: projects.locations.licenseConfigs

Resource: LicenseConfig

SubscriptionTier

State

SubscriptionTerm

Methods

`create`

`get`

`patch`