Package google.cloud.billing.v1

Index

CloudBilling

Retrieves Google Cloud Console billing accounts and associates them with projects.

GetBillingAccount

rpc GetBillingAccount(GetBillingAccountRequest) returns (BillingAccount)

Gets information about a billing account. The current authenticated user must be an owner of the billing account.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-billing
  • https://www.googleapis.com/auth/cloud-billing.readonly

For more information, see the Auth Guide.

GetProjectBillingInfo

rpc GetProjectBillingInfo(GetProjectBillingInfoRequest) returns (ProjectBillingInfo)

Gets the billing information for a project. The current authenticated user must have permission to view the project.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-billing
  • https://www.googleapis.com/auth/cloud-billing.readonly

For more information, see the Auth Guide.

ListBillingAccounts

rpc ListBillingAccounts(ListBillingAccountsRequest) returns (ListBillingAccountsResponse)

Lists the billing accounts that the current authenticated user owns.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-billing
  • https://www.googleapis.com/auth/cloud-billing.readonly

For more information, see the Auth Guide.

ListProjectBillingInfo

rpc ListProjectBillingInfo(ListProjectBillingInfoRequest) returns (ListProjectBillingInfoResponse)

Lists the projects associated with a billing account. The current authenticated user must be an owner of the billing account.

Authorization

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-billing
  • https://www.googleapis.com/auth/cloud-billing.readonly

For more information, see the Auth Guide.

UpdateProjectBillingInfo

rpc UpdateProjectBillingInfo(UpdateProjectBillingInfoRequest) returns (ProjectBillingInfo)

Sets or updates the billing account associated with a project. You specify the new billing account by setting the billing_account_name in the ProjectBillingInfo resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges.

Note: Incurred charges that have not yet been reported in the transaction history of the Google Cloud Console may be billed to the new billing account, even if the charge occurred before the new billing account was assigned to the project.

The current authenticated user must have ownership privileges for both the project and the billing account.

You can disable billing on the project by setting the billing_account_name field to empty. This action disassociates the current billing account from the project. Any billable activity of your in-use services will stop, and your application could stop functioning as expected. Any unbilled charges to date will be billed to the previously associated account. The current authenticated user must be either an owner of the project or an owner of the billing account for the project.

Note that associating a project with a closed billing account will have much the same effect as disabling billing on the project: any paid resources used by the project will be shut down. Thus, unless you wish to disable billing, you should always call this method with the name of an open billing account.

Authorization

Requires one of the following OAuth scopes:

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

For more information, see the Auth Guide.

BillingAccount

A billing account in Google Cloud Console. You can assign a billing account to one or more projects.

Fields
name

string

The resource name of the billing account. The resource name has the form billingAccounts/{billing_account_id}. For example, billingAccounts/012345-567890-ABCDEF would be the resource name for billing account 012345-567890-ABCDEF.

open

bool

True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.

display_name

string

The display name given to the billing account, such as My Billing Account. This name is displayed in the Google Cloud Console.

GetBillingAccountRequest

Request message for GetBillingAccount.

Fields
name

string

The resource name of the billing account to retrieve. For example, billingAccounts/012345-567890-ABCDEF.

GetProjectBillingInfoRequest

Request message for GetProjectBillingInfo.

Fields
name

string

The resource name of the project for which billing information is retrieved. For example, projects/tokyo-rain-123.

ListBillingAccountsRequest

Request message for ListBillingAccounts.

Fields
page_size

int32

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

page_token

string

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.

ListBillingAccountsResponse

Response message for ListBillingAccounts.

Fields
billing_accounts[]

BillingAccount

A list of billing accounts.

next_page_token

string

A token to retrieve the next page of results. To retrieve the next page, call ListBillingAccounts again with the page_token field set to this value. This field is empty if there are no more results to retrieve.

ListProjectBillingInfoRequest

Request message for ListProjectBillingInfo.

Fields
name

string

The resource name of the billing account associated with the projects that you want to list. For example, billingAccounts/012345-567890-ABCDEF.

page_size

int32

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

page_token

string

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

ListProjectBillingInfoResponse

Request message for ListProjectBillingInfoResponse.

Fields
project_billing_info[]

ProjectBillingInfo

A list of ProjectBillingInfo resources representing the projects associated with the billing account.

next_page_token

string

A token to retrieve the next page of results. To retrieve the next page, call ListProjectBillingInfo again with the page_token field set to this value. This field is empty if there are no more results to retrieve.

ProjectBillingInfo

Encapsulation of billing information for a Cloud Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).

Fields
name

string

The resource name for the ProjectBillingInfo; has the form projects/{project_id}/billingInfo. For example, the resource name for the billing information for project tokyo-rain-123 would be projects/tokyo-rain-123/billingInfo. This field is read-only.

project_id

string

The ID of the project that this ProjectBillingInfo represents, such as tokyo-rain-123. This is a convenience field so that you don't need to parse the name field to obtain a project ID. This field is read-only.

billing_account_name

string

The resource name of the billing account associated with the project, if any. For example, billingAccounts/012345-567890-ABCDEF.

billing_enabled

bool

True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. This field is read-only.

UpdateProjectBillingInfoRequest

Request message for UpdateProjectBillingInfo.

Fields
name

string

The resource name of the project associated with the billing information that you want to update. For example, projects/tokyo-rain-123.

project_billing_info

ProjectBillingInfo

The new billing information for the project. Read-only fields are ignored; thus, you may leave empty all fields except billing_account_name.