Cloud Billing API (cloudbilling:v1)

2023-10-27

6 new methods | 2 updated methods

Additions

    Methods
  • cloudbilling.billingAccounts.move

      Path : v1/{+name}:move

      Flat Path : v1/billingAccounts/{billingAccountsId}:move

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The resource name of the billing account to move. Must be of the form `billingAccounts/{billing_account_id}`. The specified billing account cannot be a subaccount, since a subaccount always belongs to the same organization as its parent account.

          Pattern : ^billingAccounts/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/cloud-billing
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Changes which parent organization a billing account belongs to.

  • cloudbilling.billingAccounts.subAccounts.list

      Path : v1/{+parent}/subAccounts

      Flat Path : v1/billingAccounts/{billingAccountsId}/subAccounts

      HTTP Method : GET

      Parameters :

        parent

          Description : Optional. The parent resource to list billing accounts from. Format: - organizations/{organization_id} eg organizations/12345678 - billingAccounts/{billing_account_id} eg `billingAccounts/012345-567890-ABCDEF`

          Pattern : ^billingAccounts/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Requested page size. The maximum page size is 100; this is also the default.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.

          Location : query

          Type : string

        filter

          Description : Options for how to filter the returned billing accounts. This only supports filtering for [subaccounts](https://cloud.google.com/billing/docs/concepts) under a single provided parent billing account. (e.g. "master_billing_account=billingAccounts/012345-678901-ABCDEF"). Boolean algebra and other fields are not currently supported.

          Location : query

          Type : string

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/cloud-billing
    • https://www.googleapis.com/auth/cloud-billing.readonly
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Lists the billing accounts that the current authenticated user has permission to [view](https://cloud.google.com/billing/docs/how-to/billing-access).

  • cloudbilling.billingAccounts.subAccounts.create

      Path : v1/{+parent}/subAccounts

      Flat Path : v1/billingAccounts/{billingAccountsId}/subAccounts

      HTTP Method : POST

      Parameters :

        parent

          Description : Optional. The parent to create a billing account from. Format: - organizations/{organization_id} eg organizations/12345678 - billingAccounts/{billing_account_id} eg `billingAccounts/012345-567890-ABCDEF`

          Pattern : ^billingAccounts/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/cloud-billing
    • https://www.googleapis.com/auth/cloud-platform
    • Description : This method creates [billing subaccounts](https://cloud.google.com/billing/docs/concepts#subaccounts). Google Cloud resellers should use the Channel Services APIs, [accounts.customers.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers/create) and [accounts.customers.entitlements.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers.entitlements/create). When creating a subaccount, the current authenticated user must have the `billing.accounts.update` IAM permission on the parent account, which is typically given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). This method will return an error if the parent account has not been provisioned for subaccounts.

  • cloudbilling.organizations.billingAccounts.list

      Path : v1/{+parent}/billingAccounts

      Flat Path : v1/organizations/{organizationsId}/billingAccounts

      HTTP Method : GET

      Parameters :

        parent

          Description : Optional. The parent resource to list billing accounts from. Format: - organizations/{organization_id} eg organizations/12345678 - billingAccounts/{billing_account_id} eg `billingAccounts/012345-567890-ABCDEF`

          Pattern : ^organizations/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          Description : Requested page size. The maximum page size is 100; this is also the default.

          Location : query

          Type : integer

          Format : int32

        pageToken

          Description : A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.

          Location : query

          Type : string

        filter

          Description : Options for how to filter the returned billing accounts. This only supports filtering for [subaccounts](https://cloud.google.com/billing/docs/concepts) under a single provided parent billing account. (e.g. "master_billing_account=billingAccounts/012345-678901-ABCDEF"). Boolean algebra and other fields are not currently supported.

          Location : query

          Type : string

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/cloud-billing
    • https://www.googleapis.com/auth/cloud-billing.readonly
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Lists the billing accounts that the current authenticated user has permission to [view](https://cloud.google.com/billing/docs/how-to/billing-access).

  • cloudbilling.organizations.billingAccounts.create

      Path : v1/{+parent}/billingAccounts

      Flat Path : v1/organizations/{organizationsId}/billingAccounts

      HTTP Method : POST

      Parameters :

        parent

          Description : Optional. The parent to create a billing account from. Format: - organizations/{organization_id} eg organizations/12345678 - billingAccounts/{billing_account_id} eg `billingAccounts/012345-567890-ABCDEF`

          Pattern : ^organizations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/cloud-billing
    • https://www.googleapis.com/auth/cloud-platform
    • Description : This method creates [billing subaccounts](https://cloud.google.com/billing/docs/concepts#subaccounts). Google Cloud resellers should use the Channel Services APIs, [accounts.customers.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers/create) and [accounts.customers.entitlements.create](https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers.entitlements/create). When creating a subaccount, the current authenticated user must have the `billing.accounts.update` IAM permission on the parent account, which is typically given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). This method will return an error if the parent account has not been provisioned for subaccounts.

  • cloudbilling.organizations.billingAccounts.move

      Path : v1/{+destinationParent}/{+name}:move

      Flat Path : v1/organizations/{organizationsId}/billingAccounts/{billingAccountsId}:move

      HTTP Method : GET

      Parameters :

        destinationParent

          Description : Required. The resource name of the Organization to reparent the billing account under. Must be of the form `organizations/{organization_id}`.

          Pattern : ^organizations/[^/]+$

          Location : path

          Required : Yes

          Type : string

        name

          Description : Required. The resource name of the billing account to move. Must be of the form `billingAccounts/{billing_account_id}`. The specified billing account cannot be a subaccount, since a subaccount always belongs to the same organization as its parent account.

          Pattern : ^billingAccounts/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order :

    • destinationParent
    • name
    • Scopes :

    • https://www.googleapis.com/auth/cloud-billing
    • https://www.googleapis.com/auth/cloud-platform
    • Description : Changes which parent organization a billing account belongs to.

Updates

    Methods
  • cloudbilling.billingAccounts.list

      Parameters :

        parent

          Description : Optional. The parent resource to list billing accounts from. Format: - organizations/{organization_id} eg organizations/12345678 - billingAccounts/{billing_account_id} eg `billingAccounts/012345-567890-ABCDEF`

          Location : query

          Type : string

  • cloudbilling.billingAccounts.create

      Parameters :

        parent

          Description : Optional. The parent to create a billing account from. Format: - organizations/{organization_id} eg organizations/12345678 - billingAccounts/{billing_account_id} eg `billingAccounts/012345-567890-ABCDEF`

          Location : query

          Type : string