Cloud Billing API
Allows developers to manage billing for their Google Cloud Platform projects programmatically
COMMUNITYBEARER0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.0",
"servers": [
{
"url": "https://cloudbilling.googleapis.com/"
}
],
"info": {
"contact": {
"name": "Google",
"url": "https://google.com",
"x-twitter": "youtube"
},
"description": "Allows developers to manage billing for their Google Cloud Platform projects programmatically.",
"license": {
"name": "Creative Commons Attribution 3.0",
"url": "http://creativecommons.org/licenses/by/3.0/"
},
"termsOfService": "https://developers.google.com/terms/",
"title": "Cloud Billing API",
"version": "v1beta",
"x-apiClientRegistration": {
"url": "https://console.developers.google.com"
},
"x-apisguru-categories": [
"analytics",
"media"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_www.google.com_images_branding_googlelogo_2x_googlelogo_color_272x92dp.png"
},
"x-origin": [
{
"format": "google",
"url": "https://cloudbilling.googleapis.com/$discovery/rest?version=v1beta",
"version": "v1"
}
],
"x-preferred": true,
"x-providerName": "googleapis.com",
"x-serviceName": "cloudbilling"
},
"externalDocs": {
"url": "https://cloud.google.com/billing/"
},
"tags": [
{
"name": "billingAccounts"
},
{
"name": "v1beta"
}
],
"paths": {
"/v1beta/{billingAccount}:estimateCostScenario": {
"parameters": [
{
"$ref": "#/components/parameters/_.xgafv"
},
{
"$ref": "#/components/parameters/access_token"
},
{
"$ref": "#/components/parameters/alt"
},
{
"$ref": "#/components/parameters/callback"
},
{
"$ref": "#/components/parameters/fields"
},
{
"$ref": "#/components/parameters/key"
},
{
"$ref": "#/components/parameters/oauth_token"
},
{
"$ref": "#/components/parameters/prettyPrint"
},
{
"$ref": "#/components/parameters/quotaUser"
},
{
"$ref": "#/components/parameters/upload_protocol"
},
{
"$ref": "#/components/parameters/uploadType"
}
],
"post": {
"description": "Use custom pricing in the estimate, using a `CostScenario` with a defined `billingAccount`.",
"operationId": "cloudbilling.billingAccounts.estimateCostScenario",
"parameters": [
{
"description": "Resource name of the billing account for the cost estimate. The resource name has the form `billingAccounts/{billing_acount_id}`. For example, `billingAccounts/012345-567890-ABCDEF` is the resource name for billing account `012345-567890-ABCDEF`. Must be specified.",
"in": "path",
"name": "billingAccount",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EstimateCostScenarioForBillingAccountRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EstimateCostScenarioForBillingAccountResponse"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Oauth2": [
"https://www.googleapis.com/auth/cloud-billing"
],
"Oauth2c": [
"https://www.googleapis.com/auth/cloud-billing"
]
},
{
"Oauth2": [
"https://www.googleapis.com/auth/cloud-billing.readonly"
],
"Oauth2c": [
"https://www.googleapis.com/auth/cloud-billing.readonly"
]
},
{
"Oauth2": [
"https://www.googleapis.com/auth/cloud-platform"
],
"Oauth2c": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
],
"tags": [
"billingAccounts"
]
}
},
"/v1beta:estimateCostScenario": {
"parameters": [
{
"$ref": "#/components/parameters/_.xgafv"
},
{
"$ref": "#/components/parameters/access_token"
},
{
"$ref": "#/components/parameters/alt"
},
{
"$ref": "#/components/parameters/callback"
},
{
"$ref": "#/components/parameters/fields"
},
{
"$ref": "#/components/parameters/key"
},
{
"$ref": "#/components/parameters/oauth_token"
},
{
"$ref": "#/components/parameters/prettyPrint"
},
{
"$ref": "#/components/parameters/quotaUser"
},
{
"$ref": "#/components/parameters/upload_protocol"
},
{
"$ref": "#/components/parameters/uploadType"
}
],
"post": {
"description": "Estimate list prices using a `CostScenario` without a defined `billingAccount`.",
"operationId": "cloudbilling.estimateCostScenario",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EstimateCostScenarioWithListPriceRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EstimateCostScenarioWithListPriceResponse"
}
}
},
"description": "Successful response"
}
},
"security": [
{
"Oauth2": [
"https://www.googleapis.com/auth/cloud-billing"
],
"Oauth2c": [
"https://www.googleapis.com/auth/cloud-billing"
]
},
{
"Oauth2": [
"https://www.googleapis.com/auth/cloud-billing.readonly"
],
"Oauth2c": [
"https://www.googleapis.com/auth/cloud-billing.readonly"
]
},
{
"Oauth2": [
"https://www.googleapis.com/auth/cloud-platform"
],
"Oauth2c": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
],
"tags": [
"v1beta"
]
}
}
},
"components": {
"parameters": {
"_.xgafv": {
"description": "V1 error format.",
"in": "query",
"name": "$.xgafv",
"schema": {
"enum": [
"1",
"2"
],
"type": "string"
}
},
"access_token": {
"description": "OAuth access token.",
"in": "query",
"name": "access_token",
"schema": {
"type": "string"
}
},
"alt": {
"description": "Data format for response.",
"in": "query",
"name": "alt",
"schema": {
"enum": [
"json",
"media",
"proto"
],
"type": "string"
}
},
"callback": {
"description": "JSONP",
"in": "query",
"name": "callback",
"schema": {
"type": "string"
}
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"in": "query",
"name": "fields",
"schema": {
"type": "string"
}
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"in": "query",
"name": "key",
"schema": {
"type": "string"
}
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"in": "query",
"name": "oauth_token",
"schema": {
"type": "string"
}
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"in": "query",
"name": "prettyPrint",
"schema": {
"type": "boolean"
}
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"in": "query",
"name": "quotaUser",
"schema": {
"type": "string"
}
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"in": "query",
"name": "uploadType",
"schema": {
"type": "string"
}
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"in": "query",
"name": "upload_protocol",
"schema": {
"type": "string"
}
}
},
"schemas": {
"CacheFillRegions": {
"description": "Specifies the regions for Cache Fill.",
"properties": {
"destinationRegion": {
"description": "The destination region for cache fill.",
"enum": [
"CACHE_FILL_DESTINATION_REGION_UNSPECIFIED",
"CACHE_FILL_DESTINATION_REGION_ASIA_PACIFIC",
"CACHE_FILL_DESTINATION_REGION_EUROPE",
"CACHE_FILL_DESTINATION_REGION_NORTH_AMERICA",
"CACHE_FILL_DESTINATION_REGION_OCEANIA",
"CACHE_FILL_DESTINATION_REGION_SOUTH_AMERICA",
"CACHE_FILL_DESTINATION_REGION_CHINA",
"CACHE_FILL_DESTINATION_REGION_OTHERS"
],
"type": "string"
},
"sourceRegion": {
"description": "The source region for cache fill.",
"enum": [
"CACHE_FILL_SOURCE_REGION_UNSPECIFIED",
"CACHE_FILL_REGION_ASIA_PACIFIC",
"CACHE_FILL_SOURCE_REGION_EUROPE",
"CACHE_FILL_SOURCE_REGION_NORTH_AMERICA",
"CACHE_FILL_SOURCE_REGION_OCEANIA",
"CACHE_FILL_SOURCE_REGION_SOUTH_AMERICA"
],
"type": "string"
}
},
"type": "object"
},
"CloudCdnEgressWorkload": {
"description": "Specifies usage for Cloud CDN egress.",
"properties": {
"cacheEgressDestination": {
"description": "The destination for the cache egress charges.",
"enum": [
"CACHE_EGRESS_DESTINATION_UNSPECIFIED",
"CACHE_EGRESS_DESTINATION_ASIA_PACIFIC",
"CACHE_EGRESS_DESTINATION_CHINA",
"CACHE_EGRESS_DESTINATION_EUROPE",
"CACHE_EGRESS_DESTINATION_NORTH_AMERICA",
"CACHE_EGRESS_DESTINATION_OCEANIA",
"CACHE_EGRESS_DESTINATION_LATIN_AMERICA",
"CACHE_EGRESS_DESTINATION_OTHER_DESTINATIONS"
],
"type": "string"
},
"cacheEgressRate": {
"$ref": "#/components/schemas/Usage",
"description": "Cache egress usage. The rate of data cache egressed in the destination. For example : units such as \"GiBy/s\" or \"TBy/mo\"."
}
},
"type": "object"
},
"CloudCdnWorkload": {
"description": "Specifies usage for Cloud CDN resources.",
"properties": {
"cacheFillOriginService": {
"description": "The source service for the cache fill.",
"enum": [
"CACHE_FILL_ORIGIN_SERVICE_UNSPECIFIED",
"CACHE_FILL_ORIGIN_SERVICE_GOOGLE_CLOUD_STORAGE_BUCKET",
"CACHE_FILL_ORIGIN_SERVICE_BACKEND_SERVICE"
],
"type": "string"
},
"cacheFillRate": {
"$ref": "#/components/schemas/Usage",
"description": "Cache fill usage. The rate of data transferred between cache fill regions. For example: units such as \"GiBy/s\" or \"TBy/mo\"."
},
"cacheFillRegions": {
"$ref": "#/components/schemas/CacheFillRegions",
"description": "The regions where data is transferred from Google data locations into Google global cache servers. The SKU prices for cache fill across services are the same."
},
"cacheLookUpRate": {
"$ref": "#/components/schemas/Usage",
"description": "Cache look up requests. This is specified to indicate the number of requests. For example: units such as \"1/s\"."
}
},
"type": "object"
},
"CloudInterconnectEgressWorkload": {
"description": "The interconnect egress only includes the Interconnect Egress. Please use the standard egress traffic interface to specify your standard egress usage.",
"properties": {
"egressRate": {
"$ref": "#/components/schemas/Usage",
"description": "Data egress usage. This usage applies when you move or copy data from one Google Cloud service to another service. Expected units such as \"GiBy/s, By/s, etc.\""
},
"interconnectConnectionLocation": {
"description": "Locations in the [Interconnect connection location table](https://cloud.google.com/vpc/network-pricing#interconnect-pricing). This is the interconnect egress charges.",
"enum": [
"INTERCONNECT_CONNECTION_LOCATION_UNSPECIFIED",
"INTERCONNECT_CONNECTION_LOCATION_ASIA",
"INTERCONNECT_CONNECTION_LOCATION_EUROPE",
"INTERCONNECT_CONNECTION_LOCATION_NORTH_AMERICA",
"INTERCONNECT_CONNECTION_LOCATION_SOUTH_AMERICA",
"INTERCONNECT_CONNECTION_LOCATION_AUSTRALIA"
],
"type": "string"
}
},
"type": "object"
},
"CloudInterconnectWorkload": {
"description": "Specifies usage for Cloud Interconnect resources.",
"properties": {
"interconnectAttachments": {
"description": "VLAN attachment used for interconnect.",
"items": {
"$ref": "#/components/schemas/VlanAttachment"
},
"type": "array"
},
"interconnectType": {
"description": "Vlan attachment type.",
"enum": [
"INTERCONNECT_TYPE_UNSPECIFIED",
"INTERCONNECT_TYPE_DEDICATED",
"INTERCONNECT_TYPE_PARTNER"
],
"type": "string"
},
"linkType": {
"description": "Interconnect circuit link type.",
"enum": [
"LINK_TYPE_UNSPECIFIED",
"LINK_TYPE_ETHERNET_10G_LR",
"LINK_TYPE_ETHERNET_100G_LR"
],
"type": "string"
},
"provisionedLinkCount": {
"$ref": "#/components/schemas/Usage",
"description": "Interconnect usage. This is specified as a unitless quantity which indicates the number of circuit provisioned in interconnect."
}
},
"type": "object"
},
"CloudStorageEgressWorkload": {
"description": "Specification of a network type. Network egress within Google Cloud applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket.This includes the network egress within Google Cloud and the general network usage.",
"properties": {
"destinationContinent": {
"description": "Where the data is sent to.",
"enum": [
"DESTINATION_CONTINENT_UNSPECIFIED",
"DESTINATION_CONTINENT_ASIA_PACIFIC",
"DESTINATION_CONTINENT_AUTRALIA",
"DESTINATION_CONTINENT_EUROPE",
"DESTINATION_CONTINENT_NORTH_AMERICA",
"DESTINATION_CONTINENT_SOUTH_AMERICA"
],
"type": "string"
},
"egressRate": {
"$ref": "#/components/schemas/Usage",
"description": "Egress usage rate. This usage applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket. Expected units such as \"GiBy/s, By/s, ...\""
},
"sourceContinent": {
"description": "Where the data comes from.",
"enum": [
"SOURCE_CONTINENT_UNSPECIFIED",
"SOURCE_CONTINENT_ASIA_PACIFIC",
"SOURCE_CONTINENT_AUSTRALIA",
"SOURCE_CONTINENT_EUROPE",
"SOURCE_CONTINENT_NORTH_AMERICA",
"SOURCE_CONTINENT_SOUTH_AMERICA"
],
"type": "string"
}
},
"type": "object"
},
"CloudStorageWorkload": {
"description": "Specifies usage of Cloud Storage resources.",
"properties": {
"dataRetrieval": {
"$ref": "#/components/schemas/Usage",
"description": "Data retrieval usage. A retrieval cost applies when data or metadata is read, copied, or rewritten . For example: units such as \"GiBy/s\" or \"By/s\"."
},
"dataStored": {
"$ref": "#/components/schemas/Usage",
"description": "Data storage usage. The amount of data stored in buckets. For example: units such as \"GiBy/s\" or \"TBy/mo\"."
},
"dualRegion": {
"$ref": "#/components/schemas/DualRegional",
"description": "Specify dual regions."
},
"multiRegion": {
"$ref": "#/components/schemas/MultiRegional",
"description": "Specify multi regions."
},
"operationA": {
"$ref": "#/components/schemas/Usage",
"description": "Class A operation usage in Cloud Storage, such as listing the objects in buckets. See the [operations pricing](https://cloud.google.com/storage/pricing#operations-pricing) tables for a list of which operations fall into each class. For example: units such as \"1/s\"."
},
"operationB": {
"$ref": "#/components/schemas/Usage",
"description": "Class B operation usage in Cloud Storage, such as `getIamPolicy`. See the [operations pricing](https://cloud.google.com/storage/pricing#operations-pricing) tables for a list of which operations fall into each class. For example: units such as \"1/s\"."
},
"region": {
"$ref": "#/components/schemas/Regional",
"description": "Specify a single region."
},
"storageClass": {
"description": "The [storage class](https://cloud.google.com/storage/docs/storage-classes#classes) of the data and operation. For example: \"standard\" and \"nearline\".",
"type": "string"
}
},
"type": "object"
},
"Commitment": {
"description": "Commitments give you the ability to pay a recurring fee in exchange for a benefit, such as a discount for your use. For example, this object might contain details of a [spend-based committed use discount (CUD)](https://cloud.google.com/docs/cuds#spend_based_commitments). Within a CostScenario, adding a commitment includes the cost of the commitment and any discounts.",
"properties": {
"name": {
"description": "Required. A name for this commitment. All commitments in a CostScenario must have unique names. Each name may be at most 128 characters long.",
"type": "string"
},
"vmResourceBasedCud": {
"$ref": "#/components/schemas/VmResourceBasedCud",
"description": "A resource-based committed use discount (CUD)."
}
},
"type": "object"
},
"CommitmentCostEstimate": {
"description": "Estimated cost for a commitment.",
"properties": {
"commitmentTotalCostEstimate": {
"$ref": "#/components/schemas/CostEstimate",
"description": "Total estimated costs for the commitment."
},
"name": {
"description": "The name of the commitment, as specified in the `CostScenario`.",
"type": "string"
},
"skuCostEstimates": {
"description": "Estimated costs for each SKU in the commitment.",
"items": {
"$ref": "#/components/schemas/SkuCostEstimate"
},
"type": "array"
}
},
"type": "object"
},
"ComputeVmWorkload": {
"description": "Specificies usage of a set of identical compute VM instances.",
"properties": {
"enableConfidentialCompute": {
"description": "Defines whether each instance has confidential compute enabled.",
"type": "boolean"
},
"guestAccelerator": {
"$ref": "#/components/schemas/GuestAccelerator",
"description": "Guest accelerators attached to each machine."
},
"instancesRunning": {
"$ref": "#/components/schemas/Usage",
"description": "VM usage. This is specified as a unitless quantity which indicates the number of instances running."
},
"licenses": {
"description": "Premium image licenses used by each instance.",
"items": {
"type": "string"
},
"type": "array"
},
"machineType": {
"$ref": "#/components/schemas/MachineType",
"description": "The machine type."
},
"persistentDisks": {
"description": "Persistent disks attached to each instance. Must include a boot disk.",
"items": {
"$ref": "#/components/schemas/PersistentDisk"
},
"type": "array"
},
"preemptible": {
"description": "Defines whether each instance is preemptible.",
"type": "boolean"
},
"region": {
"description": "The [region](https://cloud.google.com/compute/docs/regions-zones) where the VMs run. For example: \"us-central1\".",
"type": "string"
}
},
"type": "object"
},
"CostEstimate": {
"description": "An estimated cost.",
"properties": {
"creditEstimates": {
"description": "The estimated credits applied.",
"items": {
"$ref": "#/components/schemas/CreditEstimate"
},
"type": "array"
},
"netCostEstimate": {
"$ref": "#/components/schemas/Money",
"description": "The estimated net cost after applying credits."
},
"preCreditCostEstimate": {
"$ref": "#/components/schemas/Money",
"description": "The estimated cost prior to applying credits."
}
},
"type": "object"
},
"CostEstimationResult": {
"description": "The result of a estimating the costs of a `CostScenario`.",
"properties": {
"currencyCode": {
"description": "Required. The ISO 4217 currency code for the cost estimate.",
"type": "string"
},
"segmentCostEstimates": {
"description": "Required. Estimated costs for each idealized month of a `CostScenario`.",
"items": {
"$ref": "#/components/schemas/SegmentCostEstimate"
},
"type": "array"
},
"skus": {
"description": "Required. Information about SKUs used in the estimate.",
"items": {
"$ref": "#/components/schemas/Sku"
},
"type": "array"
}
},
"type": "object"
},
"CostScenario": {
"description": "Encapsulates all the information needed to perform a cost estimate. It includes a specification of the Google Cloud usage whose costs are estimated, and configuration options.",
"properties": {
"commitments": {
"description": "New commitments to estimate the costs for. The cost of the commitments will be included in the estimate result and discounts the commitment entitles will be included in the workload cost estimates. A maximum of 100 workloads can be provided.",
"items": {
"$ref": "#/components/schemas/Commitment"
},
"type": "array"
},
"scenarioConfig": {
"$ref": "#/components/schemas/ScenarioConfig",
"description": "Configuration for the scenario."
},
"workloads": {
"description": "The Google Cloud usage whose costs are estimated. A maximum of 100 workloads can be provided.",
"items": {
"$ref": "#/components/schemas/Workload"
},
"type": "array"
}
},
"type": "object"
},
"CreditEstimate": {
"description": "An estimated credit applied to the costs on a SKU.",
"properties": {
"creditAmount": {
"$ref": "#/components/schemas/Money",
"description": "The estimated credit amount."
},
"creditDescription": {
"description": "The credit description.",
"type": "string"
},
"creditType": {
"description": "The credit type.",
"type": "string"
}
},
"type": "object"
},
"CustomMachineType": {
"description": "Specification of a custom machine type.",
"properties": {
"machineSeries": {
"description": "Required. The machine series. Only certain [machine series](https://cloud.google.com/compute/docs/general-purpose-machines#custom_machine_types) support custom configurations. For example: \"n1\".",
"type": "string"
},
"memorySizeGb": {
"description": "Required. Memory size of the VM in GB (2^30 bytes). Must be an increment of 0.25 (256 MB). Each [machine series](https://cloud.google.com/compute/docs/machine-types#machine_type_comparison) has limitations on allowed values for the ratio of memory-to-vCPU count.",
"format": "double",
"type": "number"
},
"virtualCpuCount": {
"description": "Required. The number of vCPUs. The allowed values depend on the [machine series](https://cloud.google.com/compute/docs/machine-types#machine_type_comparison).",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"DualRegional": {
"description": "Area contains dual locations.",
"properties": {
"name": {
"description": "The [location name](https://cloud.google.com/storage/docs/locations#available-locations) where the data is stored. For example: \"asia1\" for dual region.",
"type": "string"
}
},
"type": "object"
},
"EstimateCostScenarioForBillingAccountRequest": {
"description": "Request for EstimateCostScenarioForBillingAccount.",
"properties": {
"costScenario": {
"$ref": "#/components/schemas/CostScenario",
"description": "The scenario to estimate costs for."
}
},
"type": "object"
},
"EstimateCostScenarioForBillingAccountResponse": {
"description": "Response for EstimateCostScenarioForBillingAccount",
"properties": {
"costEstimationResult": {
"$ref": "#/components/schemas/CostEstimationResult",
"description": "The result of the cost estimation."
}
},
"type": "object"
},
"EstimateCostScenarioWithListPriceRequest": {
"description": "Request for EstimateCostScenarioWithListPrice.",
"properties": {
"costScenario": {
"$ref": "#/components/schemas/CostScenario",
"description": "The scenario to estimate costs for."
}
},
"type": "object"
},
"EstimateCostScenarioWithListPriceResponse": {
"description": "Response for EstimateCostScenarioWithListPrice",
"properties": {
"costEstimationResult": {
"$ref": "#/components/schemas/CostEstimationResult",
"description": "The result of the cost estimation."
}
},
"type": "object"
},
"EstimationTimePoint": {
"description": "Represents a point in time.",
"properties": {
"estimationTimeFrameOffset": {
"description": "The point in time, relative to the start of the time frame covered by the cost estimate.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"GuestAccelerator": {
"description": "Specification of a set of guest accelerators attached to a machine.",
"properties": {
"acceleratorCount": {
"description": "The number of the guest accelerator cards exposed to each instance.",
"format": "int64",
"type": "string"
},
"acceleratorType": {
"description": "The type of the guest accelerator cards. For example: \"nvidia-tesla-t4\".",
"type": "string"
}
},
"type": "object"
},
"InterRegionEgress": {
"description": "Egress traffic between two regions.",
"properties": {
"destinationRegion": {
"description": "Which [region](https://cloud.google.com/compute/docs/regions-zones) the egress data goes to.",
"type": "string"
},
"egressRate": {
"$ref": "#/components/schemas/Usage",
"description": "VM to VM egress usage. Expected units such as \"GiBy/s, By/s, etc.\""
},
"sourceRegion": {
"description": "Which [region](https://cloud.google.com/compute/docs/regions-zones) the egress data comes from.",
"type": "string"
}
},
"type": "object"
},
"IntraRegionEgress": {
"description": "Egress traffic within the same region. When source region and destination region are in the same zone, using the internal IP addresses, there isn't any egress charge.",
"properties": {
"egressRate": {
"$ref": "#/components/schemas/Usage",
"description": "VM to VM egress usage. Expected units such as \"GiBy/s, By/s, etc.\""
}
},
"type": "object"
},
"MachineType": {
"description": "Specification of machine series, memory, and number of vCPUs.",
"properties": {
"customMachineType": {
"$ref": "#/components/schemas/CustomMachineType"
},
"predefinedMachineType": {
"$ref": "#/components/schemas/PredefinedMachineType"
}
},
"type": "object"
},
"Money": {
"description": "Represents an amount of money with its currency type.",
"properties": {
"currencyCode": {
"description": "The three-letter currency code defined in ISO 4217.",
"type": "string"
},
"nanos": {
"description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
"format": "int32",
"type": "integer"
},
"units": {
"description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"MultiRegional": {
"description": "Area contains multiple locations.",
"properties": {
"name": {
"description": "The [location name](https://cloud.google.com/storage/docs/locations#available-locations) where the data is stored. For example: \"us\" for multi-region.",
"type": "string"
}
},
"type": "object"
},
"PersistentDisk": {
"description": "Specification of a persistent disk attached to a VM.",
"properties": {
"diskSize": {
"$ref": "#/components/schemas/Usage",
"description": "Specifies the size of disk. Must be at least 10 GB."
},
"diskType": {
"description": "The [disk type](https://cloud.google.com/compute/docs/disks#disk-types). For example: \"pd-standard\".",
"type": "string"
},
"provisionedIops": {
"$ref": "#/components/schemas/Usage",
"description": "Indicates how many IOPS to provision for the disk for extreme persistent disks. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000."
},
"scope": {
"description": "The geographic scope of the disk. Defaults to `SCOPE_ZONAL` if not specified.",
"enum": [
"SCOPE_UNSPECIFIED",
"SCOPE_ZONAL",
"SCOPE_REGIONAL"
],
"type": "string"
}
},
"type": "object"
},
"PredefinedMachineType": {
"description": "Specification of a predefined machine type.",
"properties": {
"machineType": {
"description": "The [machine type](https://cloud.google.com/compute/docs/machine-types). For example: \"n1-standard1\".",
"type": "string"
}
},
"type": "object"
},
"PremiumTierEgressWorkload": {
"description": "Specify Premium Tier Internet egress networking.",
"properties": {
"destinationContinent": {
"description": "Where the data is sent to.",
"enum": [
"DESTINATION_CONTINENT_UNSPECIFIED",
"DESTINATION_CONTINENT_ASIA_PACIFIC",
"DESTINATION_CONTINENT_AFRICA",
"DESTINATION_CONTINENT_NORTH_AMERICA",
"DESTINATION_CONTINENT_AUTRALIA",
"DESTINATION_CONTINENT_CENTRAL_AMERICA",
"DESTINATION_CONTINENT_CHINA",
"DESTINATION_CONTINENT_EASTERN_EUROPE",
"DESTINATION_CONTINENT_WESTERN_EUROPE",
"DESTINATION_CONTINENT_EMEA",
"DESTINATION_CONTINENT_INDIA",
"DESTINATION_CONTINENT_MIDDLE_EAST",
"DESTINATION_CONTINENT_SOUTH_AMERICA"
],
"type": "string"
},
"egressRate": {
"$ref": "#/components/schemas/Usage",
"description": "Premium Tier egress usage. Expected units such as \"GiBy/s, By/s, etc.\""
},
"sourceRegion": {
"description": "Which [region](https://cloud.google.com/compute/docs/regions-zones) the egress data comes from.",
"type": "string"
}
},
"type": "object"
},
"Price": {
"description": "The price of a SKU at a point int time.",
"properties": {
"effectiveTime": {
"$ref": "#/components/schemas/EstimationTimePoint",
"description": "The timestamp within the estimation time frame when the price was set."
},
"priceType": {
"description": "The type of price. Possible values: \"RATE\"",
"type": "string"
},
"rate": {
"$ref": "#/components/schemas/Rate",
"description": "A set of tiered rates."
}
},
"type": "object"
},
"Rate": {
"description": "A SKU price consisting of tiered rates.",
"properties": {
"tiers": {
"description": "The service tiers.",
"items": {
"$ref": "#/components/schemas/RateTier"
},
"type": "array"
},
"unit": {
"description": "The SKU's pricing unit. For example, if the tier price is $1 per 1000000 Bytes, then this field will show 'By'. The `start_amount` field in each tier will be in this unit.",
"type": "string"
},
"unitCount": {
"description": "The SKU's count for the pricing unit. For example, if the tier price is $1 per 1000000 Bytes, then this column will show 1000000.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"RateTier": {
"description": "Pricing details for a service tier.",
"properties": {
"price": {
"$ref": "#/components/schemas/Money",
"description": "The price for this tier."
},
"startAmount": {
"description": "The magnitude of usage in which the tier interval begins. Example: \"From 100 GiBi the price is $1 per byte\" implies `start_amount` = 100",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"Regional": {
"description": "Area contains only one location.",
"properties": {
"name": {
"description": "The [location name](https://cloud.google.com/storage/docs/locations#available-locations). For example: \"us-central1\" for region.",
"type": "string"
}
},
"type": "object"
},
"ScenarioConfig": {
"description": "Configuration for a CostScenario. Specifies how costs are calculated.",
"properties": {
"estimateDuration": {
"description": "Time frame for the estimate. Workloads must specify usage for this duration. Duration must be at least 1 hour (3,600 seconds) and at most 10 years (315,360,000 seconds). The calculations for years and months are based on a 730-hour (2,628,000-second) month. For durations longer than one month (2,628,000 seconds), the duration is rounded up to the next month, so the estimate shows you the costs for full months. For example, a duration of 3,232,800 seconds (roughly 5 weeks) is rounded up to 2 months.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"SegmentCostEstimate": {
"description": "Workload cost estimates for a single time segment.",
"properties": {
"commitmentCostEstimates": {
"description": "Estimated costs for each commitment.",
"items": {
"$ref": "#/components/schemas/CommitmentCostEstimate"
},
"type": "array"
},
"segmentStartTime": {
"$ref": "#/components/schemas/EstimationTimePoint",
"description": "Timestamp for the start of the segment."
},
"segmentTotalCostEstimate": {
"$ref": "#/components/schemas/CostEstimate",
"description": "Total estimated costs for the time segment."
},
"workloadCostEstimates": {
"description": "Estimated costs for each workload.",
"items": {
"$ref": "#/components/schemas/WorkloadCostEstimate"
},
"type": "array"
}
},
"type": "object"
},
"Sku": {
"description": "Information about SKUs appearing in the cost estimate.",
"properties": {
"displayName": {
"description": "The display name for the SKU. Example: A2 Instance Core running in Americas",
"type": "string"
},
"prices": {
"description": "A timeline of prices for a SKU in chronological order. Note: The API currently only supports using a constant price for the entire estimation time frame so this list will contain a single value.",
"items": {
"$ref": "#/components/schemas/Price"
},
"type": "array"
},
"sku": {
"description": "The resource name for the SKU. Example: \"services/DA34-426B-A397/skus/AA95-CD31-42FE\"",
"type": "string"
}
},
"type": "object"
},
"SkuCostEstimate": {
"description": "Estimated cost for usage on a SKU.",
"properties": {
"costEstimate": {
"$ref": "#/components/schemas/CostEstimate",
"description": "The estimated cost for the usage on this SKU."
},
"sku": {
"description": "The resource name for the SKU. Example: \"services/DA34-426B-A397/skus/AA95-CD31-42FE\" More information about the SKU can be found in the `skus` field of the `CostEstimationResult`.",
"type": "string"
},
"usageAmount": {
"description": "The amount of usage on this SKU.",
"format": "double",
"type": "number"
},
"usageUnit": {
"description": "The unit for the usage on this SKU.",
"type": "string"
}
},
"type": "object"
},
"StandardTierEgressWorkload": {
"description": "Specify Standard Tier Internet egress networking.",
"properties": {
"egressRate": {
"$ref": "#/components/schemas/Usage",
"description": "Standard tier egress usage. Expected units such as \"GiBy/s, By/s, etc.\""
},
"sourceRegion": {
"description": "Which [region](https://cloud.google.com/compute/docs/regions-zones) the egress data comes from.",
"type": "string"
}
},
"type": "object"
},
"Usage": {
"description": "An amount of usage over a time frame.",
"properties": {
"usageRateTimeline": {
"$ref": "#/components/schemas/UsageRateTimeline",
"description": "A timeline of usage rates over the estimate interval."
}
},
"type": "object"
},
"UsageRateTimeline": {
"description": "A timeline of usage rates. Consists of a series of entries, each of which specifies a constant rate of usage during a time interval. Each entry contains an effective time. The usage rate is in effect from that time until the effective time of the subsequent entry, or, for the last entry, for the remaining portion of estimation time frame. Effective times are specified as an offset into the estimation time frame. Usage is considered to be zero until the `effective_time` of the first entry. All subsequent entries must have an effective time greater than the previous entry and less than the estimate time frame. The effective time on all entries must be an integer number of hours.",
"properties": {
"unit": {
"description": "The unit for the usage rate in each timeline entry. If you provide an incorrect unit for an instance, the correct unit is provided in the error message. The supported units are a subset of [The Unified Code for Units of Measure](https://ucum.org/ucum.html) standard: * **Time units (TIME-UNIT)** * `s` second * `min` minute * `h` hour * `d` day * `wk` week * `mo` month * `yr` year * `ms` millisecond * `us` microsecond * `ns` nanosecond * **Basic storage units (BASIC-STORAGE-UNIT)** * `bit` bit * `By` byte * **Count units (COUNT-UNIT)** * `count` count * **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/` division or ratio (as an infix operator). For example: `kBy/{email}` or `MiBy/10ms`. * `.` multiplication or composition (as an infix operator). For example: `GBy.d` or `k{watt}.h`. The grammar for a unit is as follows: ``` Expression = Component { \".\" Component } { \"/\" Component } ; Component = ( [ PREFIX ] UNIT | \"%\" ) [ Annotation ] | Annotation | \"1\" ; UNIT = TIME-UNIT | STORAGE-UNIT | DATA-UNIT | COUNT-UNIT Annotation = \"{\" NAME \"}\" ; ``` Examples: * Request per second: `1/s` or `{requests}/s` * GibiBytes: `GiBy` * GibiBytes * seconds: `GiBy.s`",
"type": "string"
},
"usageRateTimelineEntries": {
"description": "The timeline entries. Each entry has a start time and usage rate. The start time specifies the effective time of the usage rate. The entries must be sorted by start time in an increasing order.",
"items": {
"$ref": "#/components/schemas/UsageRateTimelineEntry"
},
"type": "array"
}
},
"type": "object"
},
"UsageRateTimelineEntry": {
"description": "A usage rate timeline entry. Each entry specifies a constant usage rate during a time interval.",
"properties": {
"effectiveTime": {
"$ref": "#/components/schemas/EstimationTimePoint",
"description": "The effective time for this entry. The usage rate is in effect starting at this time until the effective time of the subsequent entry in the timeline. The last entry defines the usage rate until the end of the `Usage` time frame. Must correspond to an integer number of hours."
},
"usageRate": {
"description": "The usage rate.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"VlanAttachment": {
"description": "VLAN attachment for cloud interconnect.",
"properties": {
"bandwidth": {
"description": "Capacities in the [pricing table](https://cloud.google.com/vpc/network-pricing#interconnect-pricing) Examples of capacity are: 50/100/200/300/400/500-Mbps, 1/2/5/10/20/50-Gbps.",
"enum": [
"BANDWIDTH_UNSPECIFIED",
"BANDWIDTH_BPS_50M",
"BANDWIDTH_BPS_100M",
"BANDWIDTH_BPS_200M",
"BANDWIDTH_BPS_300M",
"BANDWIDTH_BPS_400M",
"BANDWIDTH_BPS_500M",
"BANDWIDTH_BPS_1G",
"BANDWIDTH_BPS_2G",
"BANDWIDTH_BPS_5G",
"BANDWIDTH_BPS_10G",
"BANDWIDTH_BPS_20G",
"BANDWIDTH_BPS_50G"
],
"type": "string"
},
"vlanCount": {
"$ref": "#/components/schemas/Usage",
"description": "VLAN usage. This is specified as a unitless quantity which indicates the number of VLAN attachment used in interconnect."
}
},
"type": "object"
},
"VmResourceBasedCud": {
"description": "Specifies a resource-based committed use discount (CUD).",
"properties": {
"guestAccelerator": {
"$ref": "#/components/schemas/GuestAccelerator",
"description": "Guest accelerator, known as GPU."
},
"machineSeries": {
"description": "The machine series for CUD. For example: \"n1\" for general purpose N1 machine type commitments. \"n2\" for general purpose N2 machine type commitments. \"e2\" for general purpose E2 machine type commitments. \"n2d\" for general purpose N2D machine type commitments. \"t2d\" for general purpose T2D machine type commitments. \"c2\"/\"c2d\" for compute-optimized commitments. \"m1\"/\"m2\" for the memory-optimized commitments. \"a2' for the accelerator-optimized commitments.",
"type": "string"
},
"memorySizeGb": {
"description": "Memory size of the VM in GB (2^30 bytes). Must be an increment of 0.25 (256 MB).",
"format": "double",
"type": "number"
},
"plan": {
"description": "Commitment usage plan.",
"enum": [
"COMMITMENT_PLAN_UNSPECIFIED",
"TWELVE_MONTH",
"THIRTY_SIX_MONTH"
],
"type": "string"
},
"region": {
"description": "The region where the VM runs. For example: \"us-central1\"",
"type": "string"
},
"virtualCpuCount": {
"description": "The number of vCPUs. The number of vCPUs must be an integer of 0 or more and can be even or odd.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"VmToVmEgressWorkload": {
"description": "Specify VM to VM egress.",
"properties": {
"interRegionEgress": {
"$ref": "#/components/schemas/InterRegionEgress"
},
"intraRegionEgress": {
"$ref": "#/components/schemas/IntraRegionEgress"
}
},
"type": "object"
},
"Workload": {
"description": "Specifies usage on a single Google Cloud product over a time frame. Each Google Cloud product has its own message, containing specific product configuration parameters of the product usage amounts along each dimension in which the product is billed.",
"properties": {
"cloudCdnEgressWorkload": {
"$ref": "#/components/schemas/CloudCdnEgressWorkload",
"description": "Usage on Google Cloud CDN Egress."
},
"cloudCdnWorkload": {
"$ref": "#/components/schemas/CloudCdnWorkload",
"description": "Usage on Google Cloud CDN."
},
"cloudInterconnectEgressWorkload": {
"$ref": "#/components/schemas/CloudInterconnectEgressWorkload",
"description": "Usage on Google Cloud Interconnect Egress."
},
"cloudInterconnectWorkload": {
"$ref": "#/components/schemas/CloudInterconnectWorkload",
"description": "Usage on Google Cloud Interconnect."
},
"cloudStorageEgressWorkload": {
"$ref": "#/components/schemas/CloudStorageEgressWorkload",
"description": "Usage on a cloud storage egress."
},
"cloudStorageWorkload": {
"$ref": "#/components/schemas/CloudStorageWorkload",
"description": "Usage on Google Cloud Storage."
},
"computeVmWorkload": {
"$ref": "#/components/schemas/ComputeVmWorkload",
"description": "Usage of a Google Compute Engine Virtual Machine."
},
"name": {
"description": "Required. A name for this workload. All workloads in a `CostScenario` must have a unique `name`. Each `name` may be at most 128 characters long.",
"type": "string"
},
"premiumTierEgressWorkload": {
"$ref": "#/components/schemas/PremiumTierEgressWorkload",
"description": "Usage on Premium Tier Internet Egress."
},
"standardTierEgressWorkload": {
"$ref": "#/components/schemas/StandardTierEgressWorkload",
"description": "Usage on Standard Tier Internet Egress."
},
"vmToVmEgressWorkload": {
"$ref": "#/components/schemas/VmToVmEgressWorkload",
"description": "Usage on Vm to Vm Egress."
}
},
"type": "object"
},
"WorkloadCostEstimate": {
"description": "Estimated cost for a workload.",
"properties": {
"name": {
"description": "The name of the workload, as specified in the `CostScenario`.",
"type": "string"
},
"skuCostEstimates": {
"description": "Estimated costs for each SKU in the workload.",
"items": {
"$ref": "#/components/schemas/SkuCostEstimate"
},
"type": "array"
},
"workloadTotalCostEstimate": {
"$ref": "#/components/schemas/CostEstimate",
"description": "Total estimated costs for the workload."
}
},
"type": "object"
}
},
"securitySchemes": {
"Oauth2": {
"description": "Oauth 2.0 implicit authentication",
"flows": {
"implicit": {
"authorizationUrl": "https://accounts.google.com/o/oauth2/auth",
"scopes": {
"https://www.googleapis.com/auth/cloud-billing": "View and manage your Google Cloud Platform billing accounts",
"https://www.googleapis.com/auth/cloud-billing.readonly": "View your Google Cloud Platform billing accounts",
"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."
}
}
},
"type": "oauth2"
},
"Oauth2c": {
"description": "Oauth 2.0 authorizationCode authentication",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://accounts.google.com/o/oauth2/auth",
"scopes": {
"https://www.googleapis.com/auth/cloud-billing": "View and manage your Google Cloud Platform billing accounts",
"https://www.googleapis.com/auth/cloud-billing.readonly": "View your Google Cloud Platform billing accounts",
"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."
},
"tokenUrl": "https://accounts.google.com/o/oauth2/token"
}
},
"type": "oauth2"
}
}
}
}