Vertex AI Search Billing Accounts API

The BillingAccounts API from Vertex AI Search — 2 operation(s) for billingaccounts.

GitHub OpenAPI

Operations 2

POST /v1/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:retractLicenseConfig Retract license config billingAccountLicenseConfigs #
POST /v1/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:distributeLicenseConfig Distribute license config billingAccountLicenseConfigs #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/vertex-ai-search:vertex-ai-search-billingaccounts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

vertex-ai-search-billingaccounts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Discovery Engine Billing Accounts API
  version: v1
  description: Generated from Google's published Discovery document for Discovery Engine API (discoveryengine v1, revision 20261106). 2 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
servers:
- url: https://discoveryengine.googleapis.com
tags:
- name: BillingAccounts
paths:
  /v1/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:retractLicenseConfig:
    post:
      operationId: discoveryengine.billingAccounts.billingAccountLicenseConfigs.retractLicenseConfig
      summary: Retract license config billingAccountLicenseConfigs
      description: This method is called from the billing account side to retract the LicenseConfig from the given project back to the billing account.
      parameters:
      - name: billingAccountsId
        in: path
        required: true
        description: Resource name segment (billingAccountsId).
        schema:
          type: string
      - name: billingAccountLicenseConfigsId
        in: path
        required: true
        description: Resource name segment (billingAccountLicenseConfigsId).
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1RetractLicenseConfigRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1RetractLicenseConfigResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/discoveryengine.readwrite
        - https://www.googleapis.com/auth/discoveryengine.serving.readwrite
      - apiKey: []
      tags:
      - BillingAccounts
  ? /v1/billingAccounts/{billingAccountsId}/billingAccountLicenseConfigs/{billingAccountLicenseConfigsId}:distributeLicenseConfig
  : post:
      operationId: discoveryengine.billingAccounts.billingAccountLicenseConfigs.distributeLicenseConfig
      summary: Distribute license config billingAccountLicenseConfigs
      description: Distributes a LicenseConfig from billing account level to project level.
      parameters:
      - name: billingAccountsId
        in: path
        required: true
        description: Resource name segment (billingAccountsId).
        schema:
          type: string
      - name: billingAccountLicenseConfigsId
        in: path
        required: true
        description: Resource name segment (billingAccountLicenseConfigsId).
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DistributeLicenseConfigRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1DistributeLicenseConfigResponse'
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/cloud-platform
        - https://www.googleapis.com/auth/discoveryengine.readwrite
        - https://www.googleapis.com/auth/discoveryengine.serving.readwrite
      - apiKey: []
      tags:
      - BillingAccounts
components:
  schemas:
    GoogleCloudDiscoveryengineV1LicenseConfig:
      description: Information about users' licenses.
      type: object
      properties:
        licenseCount:
          description: Required. Number of licenses purchased.
          format: int64
          type: string
        name:
          description: 'Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}`'
          type: string
        subscriptionTerm:
          type: string
          enum:
          - SUBSCRIPTION_TERM_UNSPECIFIED
          - SUBSCRIPTION_TERM_ONE_MONTH
          - SUBSCRIPTION_TERM_ONE_YEAR
          - SUBSCRIPTION_TERM_THREE_YEARS
          - SUBSCRIPTION_TERM_CUSTOM
          description: Required. Subscription term.
        lastUserUpdateTime:
          format: google-datetime
          type: string
          description: Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, 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.).
        endDate:
          $ref: '#/components/schemas/GoogleTypeDate'
          description: Optional. The planed end date.
        geminiBundle:
          type: boolean
          description: Output only. Whether the license config is for Gemini bundle.
          readOnly: true
        subscriptionTier:
          type: string
          enum:
          - SUBSCRIPTION_TIER_UNSPECIFIED
          - SUBSCRIPTION_TIER_SEARCH
          - SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT
          - SUBSCRIPTION_TIER_NOTEBOOK_LM
          - SUBSCRIPTION_TIER_FRONTLINE_WORKER
          - SUBSCRIPTION_TIER_AGENTSPACE_STARTER
          - SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS
          - SUBSCRIPTION_TIER_ENTERPRISE
          - SUBSCRIPTION_TIER_ENTERPRISE_EMERGING
          - SUBSCRIPTION_TIER_EDU
          - SUBSCRIPTION_TIER_EDU_PRO
          - SUBSCRIPTION_TIER_EDU_EMERGING
          - SUBSCRIPTION_TIER_EDU_PRO_EMERGING
          - SUBSCRIPTION_TIER_FRONTLINE_STARTER
          - SUBSCRIPTION_TIER_CONSUMPTION_ONLY
          - SUBSCRIPTION_TIER_EDU_GOV_EMERGING
          description: Required. Subscription tier information for the license config.
        startDate:
          $ref: '#/components/schemas/GoogleTypeDate'
          description: Required. The start date.
        freeTrial:
          type: boolean
          description: Optional. Whether the license config is for free trial.
        autoRenew:
          description: Optional. Whether the license config should be auto renewed when it reaches the end date.
          type: boolean
        earlyTerminated:
          readOnly: true
          description: Output only. Indication of whether the subscription is terminated earlier than the expiration date.
          type: boolean
        state:
          type: string
          readOnly: true
          enum:
          - STATE_UNSPECIFIED
          - ACTIVE
          - EXPIRED
          - NOT_STARTED
          - WITHDRAWN
          - DEACTIVATING
          description: Output only. The state of the license config.
        earlyTerminationDate:
          $ref: '#/components/schemas/GoogleTypeDate'
          description: Output only. The date when the subscription is terminated earlier than the expiration date.
    GoogleCloudDiscoveryengineV1DistributeLicenseConfigResponse:
      properties:
        licenseConfig:
          $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1LicenseConfig'
          description: The updated or created LicenseConfig.
      description: Response message for LicenseConfigService.DistributeLicenseConfig method.
      type: object
    GoogleCloudDiscoveryengineV1RetractLicenseConfigResponse:
      type: object
      properties:
        licenseConfig:
          $ref: '#/components/schemas/GoogleCloudDiscoveryengineV1LicenseConfig'
          description: The updated LicenseConfig.
      description: Response message for LicenseConfigService.RetractLicenseConfig method.
    GoogleTypeDate:
      properties:
        day:
          description: Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
          type: integer
          format: int32
        month:
          description: Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
          type: integer
          format: int32
        year:
          type: integer
          format: int32
          description: Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
      type: object
      description: 'Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp'
    GoogleCloudDiscoveryengineV1DistributeLicenseConfigRequest:
      type: object
      description: Request message for LicenseConfigService.DistributeLicenseConfig method.
      properties:
        licenseCount:
          type: string
          description: Required. The number of licenses to distribute.
          format: int64
        location:
          type: string
          description: Required. The target GCP project region to distribute the license config to.
        projectNumber:
          description: Required. The target GCP project number to distribute the license config to.
          format: int64
          type: string
        licenseConfigId:
          description: Optional. Distribute seats to this license config instead of creating a new one. If not specified, a new license config will be created from the billing account license config.
          type: string
    GoogleCloudDiscoveryengineV1RetractLicenseConfigRequest:
      properties:
        fullRetract:
          type: boolean
          description: Optional. If set to true, retract the entire license config. Otherwise, retract the specified license count.
        licenseCount:
          format: int64
          type: string
          description: Optional. The number of licenses to retract. Only used when full_retract is false.
        licenseConfig:
          type: string
          description: 'Required. Full resource name of LicenseConfig. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config_id}`.'
      description: Request message for LicenseConfigService.RetractLicenseConfig method.
      type: object
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/cloud_search.query: Search your organization's data in the Cloud Search index
            https://www.googleapis.com/auth/discoveryengine.readwrite: View, edit, create, and delete all your data associated with any Discovery Engine API product, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, including both end user data and administration or configuration data.
            https://www.googleapis.com/auth/discoveryengine.serving.readwrite: Interact with Discovery Engine API products, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, on your behalf. It will also allow the app to view all data that you have access to when you use or interact with a Discovery Engine API product.
            https://www.googleapis.com/auth/discoveryengine.assist.readwrite: View your Agentspace chat history, including uploaded files and generated reports and visualizations, and interact with the Agentspace assistant on your behalf. Also view the artifacts you access through NotebookLM Enterprise.
            https://www.googleapis.com/auth/cloud-platform: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
externalDocs:
  url: https://cloud.google.com/generative-ai-app-builder/docs/
x-provenance:
  method: harvested
  publisher: Google
  source: https://discoveryengine.googleapis.com/$discovery/rest?version=v1
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261106)