Index
CloudBilling
(interface)CloudCatalog
(interface)AggregationInfo
(message)AggregationInfo.AggregationInterval
(enum)AggregationInfo.AggregationLevel
(enum)BillingAccount
(message)Category
(message)CreateBillingAccountRequest
(message)GeoTaxonomy
(message)GeoTaxonomy.Type
(enum)GetBillingAccountRequest
(message)GetProjectBillingInfoRequest
(message)ListBillingAccountsRequest
(message)ListBillingAccountsResponse
(message)ListProjectBillingInfoRequest
(message)ListProjectBillingInfoResponse
(message)ListServicesRequest
(message)ListServicesResponse
(message)ListSkusRequest
(message)ListSkusResponse
(message)MoveBillingAccountRequest
(message)PricingExpression
(message)PricingExpression.TierRate
(message)PricingInfo
(message)ProjectBillingInfo
(message)Service
(message)Sku
(message)UpdateBillingAccountRequest
(message)UpdateProjectBillingInfoRequest
(message)
CloudBilling
Retrieves the Google Cloud Console billing accounts and associates them with projects.
CreateBillingAccount |
---|
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
|
GetBillingAccount |
---|
Gets information about a billing account. The current authenticated user must be a viewer of the billing account.
|
GetIamPolicy |
---|
Gets the access control policy for a billing account. The caller must have the
|
GetProjectBillingInfo |
---|
Gets the billing information for a project. The current authenticated user must have the
|
ListBillingAccounts |
---|
Lists the billing accounts that the current authenticated user has permission to view.
|
ListProjectBillingInfo |
---|
Lists the projects associated with a billing account. The current authenticated user must have the
|
MoveBillingAccount |
---|
Changes which parent organization a billing account belongs to.
|
SetIamPolicy |
---|
Sets the access control policy for a billing account. Replaces any existing policy. The caller must have the
|
TestIamPermissions |
---|
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.
|
UpdateBillingAccount |
---|
Updates a billing account's fields. Currently the only field that can be edited is
|
UpdateProjectBillingInfo |
---|
Sets or updates the billing account associated with a project. You specify the new billing account by setting the 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 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.
|
CloudCatalog
A catalog of Google Cloud Platform services and SKUs. Provides pricing information and metadata on Google Cloud Platform services and SKUs.
ListServices |
---|
Lists all public cloud services.
|
ListSkus |
---|
Lists all publicly available SKUs for a given cloud service.
|
AggregationInfo
Represents the aggregation level and interval for pricing of a single SKU.
Fields | |
---|---|
aggregation_level |
|
aggregation_interval |
|
aggregation_count |
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 |
Output only. The resource name of the billing account. The resource name has the form |
open |
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 |
The display name given to the billing account, such as |
master_billing_account |
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 |
Output only. The billing account's parent resource identifier. Use the |
Category
Represents the category hierarchy of a SKU.
Fields | |
---|---|
service_display_name |
The display name of the service this SKU belongs to. |
resource_family |
The type of product the SKU refers to. Example: "Compute", "Storage", "Network", "ApplicationServices" etc. |
resource_group |
A group classification for related SKUs. Example: "RAM", "GPU", "Prediction", "Ops", "GoogleEgress" etc. |
usage_type |
Represents how the SKU is consumed. Example: "OnDemand", "Preemptible", "Commit1Mo", "Commit1Yr" etc. |
CreateBillingAccountRequest
Request message for CreateBillingAccount
.
Fields | |
---|---|
billing_account |
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 |
Optional. The parent to create a billing account from. Format: - |
GeoTaxonomy
Encapsulates the geographic taxonomy data for a sku.
Fields | |
---|---|
type |
The type of Geo Taxonomy: GLOBAL, REGIONAL, or MULTI_REGIONAL. |
regions[] |
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 |
Required. The resource name of the billing account to retrieve. For example, |
GetProjectBillingInfoRequest
Request message for GetProjectBillingInfo
.
Fields | |
---|---|
name |
Required. The resource name of the project for which billing information is retrieved. For example, |
ListBillingAccountsRequest
Request message for ListBillingAccounts
.
Fields | |
---|---|
page_size |
Requested page size. The maximum page size is 100; this is also the default. |
page_token |
A token identifying a page of results to return. This should be a |
filter |
Options for how to filter the returned billing accounts. This only supports filtering for subaccounts under a single provided parent billing account. (for example, |
parent |
Optional. The parent resource to list billing accounts from. Format: - |
ListBillingAccountsResponse
Response message for ListBillingAccounts
.
Fields | |
---|---|
billing_accounts[] |
A list of billing accounts. |
next_page_token |
A token to retrieve the next page of results. To retrieve the next page, call |
ListProjectBillingInfoRequest
Request message for ListProjectBillingInfo
.
Fields | |
---|---|
name |
Required. The resource name of the billing account associated with the projects that you want to list. For example, |
page_size |
Requested page size. The maximum page size is 100; this is also the default. |
page_token |
A token identifying a page of results to be returned. This should be a |
ListProjectBillingInfoResponse
Request message for ListProjectBillingInfoResponse
.
Fields | |
---|---|
project_billing_info[] |
A list of |
next_page_token |
A token to retrieve the next page of results. To retrieve the next page, call |
ListServicesRequest
Request message for ListServices
.
Fields | |
---|---|
page_size |
Requested page size. Defaults to 5000. |
page_token |
A token identifying a page of results to return. This should be a |
ListServicesResponse
Response message for ListServices
.
Fields | |
---|---|
services[] |
A list of services. |
next_page_token |
A token to retrieve the next page of results. To retrieve the next page, call |
ListSkusRequest
Request message for ListSkus
.
Fields | |
---|---|
parent |
Required. The name of the service. Example: "services/DA34-426B-A397" |
start_time |
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 |
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 |
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 |
Requested page size. Defaults to 5000. |
page_token |
A token identifying a page of results to return. This should be a |
ListSkusResponse
Response message for ListSkus
.
Fields | |
---|---|
skus[] |
The list of public SKUs of the given service. |
next_page_token |
A token to retrieve the next page of results. To retrieve the next page, call |
MoveBillingAccountRequest
Request message for MoveBillingAccount
RPC.
Fields | |
---|---|
name |
Required. The resource name of the billing account to move. Must be of the form |
destination_parent |
Required. The resource name of the Organization to move the billing account under. Must be of the form |
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 |
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 |
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[] |
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 |
The unit of usage in human readable form. Example: "gibi byte". |
base_unit |
The base unit for the SKU which is the unit used in usage exports. Example: "By" |
base_unit_description |
The base unit in human readable form. Example: "byte". |
base_unit_conversion_factor |
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 |
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 |
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 |
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 |
An optional human readable summary of the pricing information, has a maximum length of 256 characters. |
pricing_expression |
Expresses the pricing formula. See |
aggregation_info |
Aggregation Info. This can be left unspecified if the pricing expression doesn't require aggregation. |
currency_conversion_rate |
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 |
Output only. The resource name for the |
project_id |
Output only. The ID of the project that this |
billing_account_name |
The resource name of the billing account associated with the project, if any. For example, |
billing_enabled |
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 |
The resource name for the service. Example: "services/DA34-426B-A397" |
service_id |
The identifier for the service. Example: "DA34-426B-A397" |
display_name |
A human readable display name for this service. |
business_entity_name |
The business under which the service is offered. Ex. "businessEntities/GCP", "businessEntities/Maps" |
Sku
Encapsulates a single SKU in Google Cloud Platform
Fields | |
---|---|
name |
The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" |
sku_id |
The identifier for the SKU. Example: "AA95-CD31-42FE" |
description |
A human readable description of the SKU, has a maximum length of 256 characters. |
category |
The category hierarchy of this SKU, purely for organizational purpose. |
service_regions[] |
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[] |
A timeline of pricing info for this SKU in chronological order. |
service_provider_name |
Identifies the service provider. This is 'Google' for first party services in Google Cloud Platform. |
geo_taxonomy |
The geographic taxonomy for this sku. |
UpdateBillingAccountRequest
Request message for UpdateBillingAccount
.
Fields | |
---|---|
name |
Required. The name of the billing account resource to be updated. |
account |
Required. The billing account resource to replace the resource on the server. |
update_mask |
The update mask applied to the resource. Only "display_name" is currently supported. |
UpdateProjectBillingInfoRequest
Request message for UpdateProjectBillingInfo
.
Fields | |
---|---|
name |
Required. The resource name of the project associated with the billing information that you want to update. For example, |
project_billing_info |
The new billing information for the project. Output-only fields are ignored; thus, you can leave empty all fields except |