REST Resource: billingAccounts.billingAccountLicenseConfigs

Resource: BillingAccountLicenseConfig

Information about license configs at billing account level.

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

string

Immutable. Identifier. The fully qualified resource name of the billing account license config. Format: billingAccounts/{billingAccount}/billingAccountLicenseConfigs/{billingAccountLicenseConfig}.
licenseCount

string (int64 format)

Required. The number of licenses purchased under this billing account license config.
licenseConfigDistributions

map (key: string, value: string (int64 format))

A map of LicenseConfig names to the number of licenses distributed to each.

The key is the full resource name of the LicenseConfig, such as projects/{project}/locations/{location}/licenseConfigs/{licenseConfig}. The value is the count of licenses allocated to it.
subscriptionName

string

Output only. The corresponding SubV3 subscription name.
subscriptionTier

enum (SubscriptionTier)

Required. The subscription tier.
subscriptionTerm

enum (SubscriptionTerm)

Required. The subscription term.
startDate

object (Date)

Required. The subscription start date.
endDate

object (Date)

Optional. The planed subscription end date.
state

enum (State)

Output only. The state of the BillingAccountLicenseConfig.
autoRenew

boolean

Whether the BillingAccountLicenseConfig is auto renewed when it reaches the end date.
procurementEntitlementId

string

The procurement entitlement id of the subscription.
subscriptionDisplayName

string

The subscription display name.
geminiBundle

boolean

Whether the license config is for Gemini bundle.
earlyTerminated

boolean

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)

The date when the subscription is terminated earlier than the expiration date.

State

BillingAccountLicenseConfig state enumeration.

Enums
STATE_UNSPECIFIED The BillingAccountLicenseConfig does not exist. Default value. Do not use.
ACTIVE The BillingAccountLicenseConfig is active and being used.
EXPIRED The BillingAccountLicenseConfig has expired.
NOT_STARTED The BillingAccountLicenseConfig has not started yet, and its start date is in the future.
DEACTIVATING The license config is terminated earlier than the expiration date and it is deactivating. The customer will still have access in this state. It will be converted to EXPIRED after the deactivating period ends (14 days) or when the end date is reached, whichever comes first.

Methods

distributeLicenseConfig

 Distributes a LicenseConfig from billing account level to project level.

get

 Gets a BillingAccountLicenseConfig.

list

 Lists all BillingAccountLicenseConfigs for a given billing account.

retractLicenseConfig

 This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.