Package google.cloud.billing.v1

Index

CloudBilling

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

CreateBillingAccount

rpc CreateBillingAccount(CreateBillingAccountRequest) returns (BillingAccount)

This method creates billing subaccounts.

Google Cloud resellers should use the Channel Services APIs, accounts.customers.create and 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. This method will return an error if the parent account has not been provisioned for subaccounts.

Authorization scopes

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 Authentication Overview.
GetBillingAccount

rpc GetBillingAccount(GetBillingAccountRequest) returns (BillingAccount)

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

Authorization scopes

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 Authentication Overview.
GetIamPolicy

rpc GetIamPolicy(GetIamPolicyRequest) returns (Policy)

Gets the access control policy for a billing account. The caller must have the billing.accounts.getIamPolicy permission on the account, which is often given to billing account viewers.

Authorization scopes

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 Authentication Overview.
GetProjectBillingInfo

rpc GetProjectBillingInfo(GetProjectBillingInfoRequest) returns (ProjectBillingInfo)

Gets the billing information for a project. The current authenticated user must have the resourcemanager.projects.get permission for the project, which can be granted by assigning the Project Viewer role.

Authorization scopes

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 Authentication Overview.
ListBillingAccounts

rpc ListBillingAccounts(ListBillingAccountsRequest) returns (ListBillingAccountsResponse)

Lists the billing accounts that the current authenticated user has permission to view.

Authorization scopes

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 Authentication Overview.
ListProjectBillingInfo

rpc ListProjectBillingInfo(ListProjectBillingInfoRequest) returns (ListProjectBillingInfoResponse)

Lists the projects associated with a billing account. The current authenticated user must have the billing.resourceAssociations.list IAM permission, which is often given to billing account viewers.

Authorization scopes

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 Authentication Overview.
MoveBillingAccount

rpc MoveBillingAccount(MoveBillingAccountRequest) returns (BillingAccount)

Changes which parent organization a billing account belongs to.

Authorization scopes

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 Authentication Overview.
SetIamPolicy

rpc SetIamPolicy(SetIamPolicyRequest) returns (Policy)

Sets the access control policy for a billing account. Replaces any existing policy. The caller must have the billing.accounts.setIamPolicy permission on the account, which is often given to billing account administrators.

Authorization scopes

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 Authentication Overview.
TestIamPermissions

rpc TestIamPermissions(TestIamPermissionsRequest) returns (TestIamPermissionsResponse)

Tests the access control policy for a billing account. This method takes the resource and a set of permissions as input and returns the subset of the input permissions that the caller is allowed for that resource.

Authorization scopes

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 Authentication Overview.
UpdateBillingAccount

rpc UpdateBillingAccount(UpdateBillingAccountRequest) returns (BillingAccount)

Updates a billing account's fields. Currently the only field that can be edited is display_name. The current authenticated user must have the billing.accounts.update IAM permission, which is typically given to the administrator of the billing account.

Authorization scopes

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 Authentication Overview.
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 might 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 scopes

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 Authentication Overview.

CloudCatalog

A catalog of Google Cloud Platform services and SKUs. Provides pricing information and metadata on Google Cloud Platform services and SKUs.

ListServices

rpc ListServices(ListServicesRequest) returns (ListServicesResponse)

Lists all public cloud services.

Authorization scopes

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 Authentication Overview.
ListSkus

rpc ListSkus(ListSkusRequest) returns (ListSkusResponse)

Lists all publicly available SKUs for a given cloud service.

Authorization scopes

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 Authentication Overview.

AggregationInfo

Represents the aggregation level and interval for pricing of a single SKU.

Fields
aggregation_level

AggregationLevel
aggregation_interval

AggregationInterval
aggregation_count

int32

The number of intervals to aggregate over. Example: If aggregation_level is "DAILY" and aggregation_count is 14, aggregation will be over 14 days.

AggregationInterval

The interval at which usage is aggregated to compute cost. Example: "MONTHLY" aggregation interval indicates that usage for tiered pricing is aggregated every month.

Enums
AGGREGATION_INTERVAL_UNSPECIFIED
DAILY
MONTHLY

AggregationLevel

The level at which usage is aggregated to compute cost. Example: "ACCOUNT" aggregation level indicates that usage for tiered pricing is aggregated across all projects in a single account.

Enums
AGGREGATION_LEVEL_UNSPECIFIED
ACCOUNT
PROJECT

BillingAccount

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

Fields
name

string

Output only. 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

Output only. 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 are 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.
master_billing_account

string

If this account is a subaccount, then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.
parent

string

Output only. The billing account's parent resource identifier. Use the MoveBillingAccount method to update the account's parent resource if it is a organization. Format: - organizations/{organization_id}, for example, organizations/12345678 - billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF
currency_code

string

Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as USD.

Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account.

Category

Represents the category hierarchy of a SKU.

Fields
service_display_name

string

The display name of the service this SKU belongs to.
resource_family

string

The type of product the SKU refers to. Example: "Compute", "Storage", "Network", "ApplicationServices" etc.
resource_group

string

A group classification for related SKUs. Example: "RAM", "GPU", "Prediction", "Ops", "GoogleEgress" etc.
usage_type

string

Represents how the SKU is consumed. Example: "OnDemand", "Preemptible", "Commit1Mo", "Commit1Yr" etc.

CreateBillingAccountRequest

Request message for CreateBillingAccount.

Fields
billing_account

BillingAccount

Required. The billing account resource to create. Currently CreateBillingAccount only supports subaccount creation, so any created billing accounts must be under a provided parent billing account.
parent

string

Optional. The parent to create a billing account from. Format: - billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF

GeoTaxonomy

Encapsulates the geographic taxonomy data for a sku.

Fields
type

Type

The type of Geo Taxonomy: GLOBAL, REGIONAL, or MULTI_REGIONAL.
regions[]

string

The list of regions associated with a sku. Empty for Global skus, which are associated with all Google Cloud regions.

Type

The type of Geo Taxonomy: GLOBAL, REGIONAL, or MULTI_REGIONAL.

Enums
TYPE_UNSPECIFIED The type is not specified.
GLOBAL The sku is global in nature, e.g. a license sku. Global skus are available in all regions, and so have an empty region list.
REGIONAL The sku is available in a specific region, e.g. "us-west2".
MULTI_REGIONAL The sku is associated with multiple regions, e.g. "us-west2" and "us-east1".

GetBillingAccountRequest

Request message for GetBillingAccount.

Fields
name

string

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

GetProjectBillingInfoRequest

Request message for GetProjectBillingInfo.

Fields
name

string

Required. 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.
filter

string

Options for how to filter the returned billing accounts. This only supports filtering for subaccounts under a single provided parent billing account. (for example, master_billing_account=billingAccounts/012345-678901-ABCDEF). Boolean algebra and other fields are not currently supported.
parent

string

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

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

Required. 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.

ListServicesRequest

Request message for ListServices.

Fields
page_size

int32

Requested page size. Defaults to 5000.
page_token

string

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

ListServicesResponse

Response message for ListServices.

Fields
services[]

Service

A list of services.
next_page_token

string

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

ListSkusRequest

Request message for ListSkus.

Fields
parent

string

Required. The name of the service. Example: "services/6F81-5844-456A"
start_time

Timestamp

Optional inclusive start time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most).
end_time

Timestamp

Optional exclusive end time of the time range for which the pricing versions will be returned. Timestamps in the future are not allowed. The time range has to be within a single calendar month in America/Los_Angeles timezone. Time range as a whole is optional. If not specified, the latest pricing will be returned (up to 12 hours old at most).
currency_code

string

The ISO 4217 currency code for the pricing info in the response proto. Will use the conversion rate as of start_time. Optional. If not specified USD will be used.
page_size

int32

Requested page size. Defaults to 5000.
page_token

string

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

ListSkusResponse

Response message for ListSkus.

Fields
skus[]

Sku

The list of public SKUs of the given service.
next_page_token

string

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

MoveBillingAccountRequest

Request message for MoveBillingAccount RPC.

Fields
name

string

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.
destination_parent

string

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

PricingExpression

Expresses a mathematical pricing formula. For Example:-

usage_unit: GBy tiered_rates: [start_usage_amount: 20, unit_price: $10] [start_usage_amount: 100, unit_price: $5]

The above expresses a pricing formula where the first 20GB is free, the next 80GB is priced at $10 per GB followed by $5 per GB for additional usage.

Fields
usage_unit

string

The short hand for unit of usage this pricing is specified in. Example: usage_unit of "GiBy" means that usage is specified in "Gibi Byte".
display_quantity

double

The recommended quantity of units for displaying pricing info. When displaying pricing info it is recommended to display: (unit_price * display_quantity) per display_quantity usage_unit. This field does not affect the pricing formula and is for display purposes only. Example: If the unit_price is "0.0001 USD", the usage_unit is "GB" and the display_quantity is "1000" then the recommended way of displaying the pricing info is "0.10 USD per 1000 GB"
tiered_rates[]

TierRate

The list of tiered rates for this pricing. The total cost is computed by applying each of the tiered rates on usage. This repeated list is sorted by ascending order of start_usage_amount.
usage_unit_description

string

The unit of usage in human readable form. Example: "gibi byte".
base_unit

string

The base unit for the SKU which is the unit used in usage exports. Example: "By"
base_unit_description

string

The base unit in human readable form. Example: "byte".
base_unit_conversion_factor

double

Conversion factor for converting from price per usage_unit to price per base_unit, and start_usage_amount to start_usage_amount in base_unit. unit_price / base_unit_conversion_factor = price per base_unit. start_usage_amount * base_unit_conversion_factor = start_usage_amount in base_unit.

TierRate

The price rate indicating starting usage and its corresponding price.

Fields
start_usage_amount

double

Usage is priced at this rate only after this amount. Example: start_usage_amount of 10 indicates that the usage will be priced at the unit_price after the first 10 usage_units.
unit_price

Money

The price per unit of usage. Example: unit_price of amount $10 indicates that each unit will cost $10.

PricingInfo

Represents the pricing information for a SKU at a single point of time.

Fields
effective_time

Timestamp

The timestamp from which this pricing was effective within the requested time range. This is guaranteed to be greater than or equal to the start_time field in the request and less than the end_time field in the request. If a time range was not specified in the request this field will be equivalent to a time within the last 12 hours, indicating the latest pricing info.
summary

string

An optional human readable summary of the pricing information, has a maximum length of 256 characters.
pricing_expression

PricingExpression

Expresses the pricing formula. See PricingExpression for an example.
aggregation_info

AggregationInfo

Aggregation Info. This can be left unspecified if the pricing expression doesn't require aggregation.
currency_conversion_rate

double

Conversion rate used for currency conversion, from USD to the currency specified in the request. This includes any surcharge collected for billing in non USD currency. If a currency is not specified in the request this defaults to 1.0. Example: USD * currency_conversion_rate = JPY

ProjectBillingInfo

Encapsulation of billing information for a Google 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

Output only. 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.
project_id

string

Output only. 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.
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

Output only. 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.

Service

Encapsulates a single service in Google Cloud Platform.

Fields
name

string

The resource name for the service. Example: "services/6F81-5844-456A"
service_id

string

The identifier for the service. Example: "6F81-5844-456A"
display_name

string

A human readable display name for this service.
business_entity_name

string

The business under which the service is offered. Ex. "businessEntities/GCP", "businessEntities/Maps"

Sku

Encapsulates a single SKU in Google Cloud

Fields
name

string

The resource name for the SKU. Example: "services/6F81-5844-456A/skus/D041-B8A1-6E0B"
sku_id

string

The identifier for the SKU. Example: "D041-B8A1-6E0B"
description

string

A human readable description of the SKU, has a maximum length of 256 characters.
category

Category

The category hierarchy of this SKU, purely for organizational purpose.
service_regions[]

string

List of service regions this SKU is offered at. Example: "asia-east1" Service regions can be found at https://cloud.google.com/about/locations/
pricing_info[]

PricingInfo

A timeline of pricing info for this SKU in chronological order.
service_provider_name

string

Identifies the service provider. This is 'Google' for first party services in Google Cloud Platform.
geo_taxonomy

GeoTaxonomy

The geographic taxonomy for this sku.

UpdateBillingAccountRequest

Request message for UpdateBillingAccount.

Fields
name

string

Required. The name of the billing account resource to be updated.
account

BillingAccount

Required. The billing account resource to replace the resource on the server.
update_mask

FieldMask

The update mask applied to the resource. Only "display_name" is currently supported.

UpdateProjectBillingInfoRequest

Request message for UpdateProjectBillingInfo.

Fields
name

string

Required. 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. Output-only fields are ignored; thus, you can leave empty all fields except billing_account_name.