Method: billingAccounts.billingAccountLicenseConfigs.retractLicenseConfig

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

HTTP request

POST https://discoveryengine.googleapis.com/v1alpha/{billingAccountLicenseConfig=billingAccounts/*/billingAccountLicenseConfigs/*}:retractLicenseConfig

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
billingAccountLicenseConfig

string

Required. Full resource name of BillingAccountLicenseConfig.

Format: billingAccounts/{billingAccount}/billingAccountLicenseConfigs/{billingAccountLicenseConfigId}.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "licenseConfig": string,
  "fullRetract": boolean,
  "licenseCount": string
}
Fields
licenseConfig

string

Required. Full resource name of LicenseConfig.

Format: projects/{project}/locations/{location}/licenseConfigs/{licenseConfigId}.
fullRetract

boolean

Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.
licenseCount

string (int64 format)

Optional. The number of licenses to retract. Only used when fullRetract is false.

Response body

Response message for LicenseConfigService.RetractLicenseConfig method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "licenseConfig": {
    object (LicenseConfig)
  }
}
Fields
licenseConfig

object (LicenseConfig)

The updated LicenseConfig.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the billingAccountLicenseConfig resource:

  • discoveryengine.billingAccountLicenseConfigs.retract

For more information, see the IAM documentation.