357 lines
16 KiB
JSON
357 lines
16 KiB
JSON
{
|
|
"id": "cloudbilling:v1",
|
|
"auth": {
|
|
"oauth2": {
|
|
"scopes": {
|
|
"https://www.googleapis.com/auth/cloud-platform": {
|
|
"description": "View and manage your data across Google Cloud Platform services"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Allows developers to manage billing for their Google Cloud Platform projects\n programmatically.",
|
|
"protocol": "rest",
|
|
"title": "Google Cloud Billing API",
|
|
"resources": {
|
|
"projects": {
|
|
"methods": {
|
|
"updateBillingInfo": {
|
|
"id": "cloudbilling.projects.updateBillingInfo",
|
|
"response": {
|
|
"$ref": "ProjectBillingInfo"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"description": "Sets or updates the billing account associated with a project. You specify\nthe new billing account by setting the `billing_account_name` in the\n`ProjectBillingInfo` resource to the resource name of a billing account.\nAssociating a project with an open billing account enables billing on the\nproject and allows charges for resource usage. If the project already had a\nbilling account, this method changes the billing account used for resource\nusage charges.\n\n*Note:* Incurred charges that have not yet been reported in the transaction\nhistory of the Google Cloud Console may be billed to the new billing\naccount, even if the charge occurred before the new billing account was\nassigned to the project.\n\nThe current authenticated user must have ownership privileges for both the\n[project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n) and the [billing\naccount](https://support.google.com/cloud/answer/4430947).\n\nYou can disable billing on the project by setting the\n`billing_account_name` field to empty. This action disassociates the\ncurrent billing account from the project. Any billable activity of your\nin-use services will stop, and your application could stop functioning as\nexpected. Any unbilled charges to date will be billed to the previously\nassociated account. The current authenticated user must be either an owner\nof the project or an owner of the billing account for the project.\n\nNote that associating a project with a *closed* billing account will have\nmuch the same effect as disabling billing on the project: any paid\nresources used by the project will be shut down. Thus, unless you wish to\ndisable billing, you should always call this method with the name of an\n*open* billing account.",
|
|
"request": {
|
|
"$ref": "ProjectBillingInfo"
|
|
},
|
|
"flatPath": "v1/projects/{projectsId}/billingInfo",
|
|
"httpMethod": "PUT",
|
|
"parameters": {
|
|
"name": {
|
|
"description": "The resource name of the project associated with the billing information\nthat you want to update. For example, `projects/tokyo-rain-123`.",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+$",
|
|
"location": "path",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1/{+name}/billingInfo",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
]
|
|
},
|
|
"getBillingInfo": {
|
|
"id": "cloudbilling.projects.getBillingInfo",
|
|
"response": {
|
|
"$ref": "ProjectBillingInfo"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"description": "Gets the billing information for a project. The current authenticated user\nmust have [permission to view the\nproject](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo\n).",
|
|
"flatPath": "v1/projects/{projectsId}/billingInfo",
|
|
"httpMethod": "GET",
|
|
"parameters": {
|
|
"name": {
|
|
"description": "The resource name of the project for which billing information is\nretrieved. For example, `projects/tokyo-rain-123`.",
|
|
"required": true,
|
|
"pattern": "^projects/[^/]+$",
|
|
"location": "path",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1/{+name}/billingInfo",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"billingAccounts": {
|
|
"resources": {
|
|
"projects": {
|
|
"methods": {
|
|
"list": {
|
|
"id": "cloudbilling.billingAccounts.projects.list",
|
|
"response": {
|
|
"$ref": "ListProjectBillingInfoResponse"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"description": "Lists the projects associated with a billing account. The current\nauthenticated user must be an [owner of the billing\naccount](https://support.google.com/cloud/answer/4430947).",
|
|
"flatPath": "v1/billingAccounts/{billingAccountsId}/projects",
|
|
"httpMethod": "GET",
|
|
"parameters": {
|
|
"pageSize": {
|
|
"description": "Requested page size. The maximum page size is 100; this is also the\ndefault.",
|
|
"location": "query",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"name": {
|
|
"description": "The resource name of the billing account associated with the projects that\nyou want to list. For example, `billingAccounts/012345-567890-ABCDEF`.",
|
|
"required": true,
|
|
"pattern": "^billingAccounts/[^/]+$",
|
|
"location": "path",
|
|
"type": "string"
|
|
},
|
|
"pageToken": {
|
|
"description": "A token identifying a page of results to be returned. This should be a\n`next_page_token` value returned from a previous `ListProjectBillingInfo`\ncall. If unspecified, the first page of results is returned.",
|
|
"location": "query",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1/{+name}/projects",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"methods": {
|
|
"get": {
|
|
"id": "cloudbilling.billingAccounts.get",
|
|
"response": {
|
|
"$ref": "BillingAccount"
|
|
},
|
|
"parameterOrder": [
|
|
"name"
|
|
],
|
|
"description": "Gets information about a billing account. The current authenticated user\nmust be an [owner of the billing\naccount](https://support.google.com/cloud/answer/4430947).",
|
|
"flatPath": "v1/billingAccounts/{billingAccountsId}",
|
|
"httpMethod": "GET",
|
|
"parameters": {
|
|
"name": {
|
|
"description": "The resource name of the billing account to retrieve. For example,\n`billingAccounts/012345-567890-ABCDEF`.",
|
|
"required": true,
|
|
"pattern": "^billingAccounts/[^/]+$",
|
|
"location": "path",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1/{+name}",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
]
|
|
},
|
|
"list": {
|
|
"id": "cloudbilling.billingAccounts.list",
|
|
"response": {
|
|
"$ref": "ListBillingAccountsResponse"
|
|
},
|
|
"parameterOrder": [],
|
|
"description": "Lists the billing accounts that the current authenticated user\n[owns](https://support.google.com/cloud/answer/4430947).",
|
|
"flatPath": "v1/billingAccounts",
|
|
"httpMethod": "GET",
|
|
"parameters": {
|
|
"pageSize": {
|
|
"description": "Requested page size. The maximum page size is 100; this is also the\ndefault.",
|
|
"location": "query",
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"pageToken": {
|
|
"description": "A token identifying a page of results to return. This should be a\n`next_page_token` value returned from a previous `ListBillingAccounts`\ncall. If unspecified, the first page of results is returned.",
|
|
"location": "query",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"path": "v1/billingAccounts",
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/cloud-platform"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"schemas": {
|
|
"ProjectBillingInfo": {
|
|
"description": "Encapsulation of billing information for a Cloud Console project. A project\nhas at most one associated billing account at a time (but a billing account\ncan be assigned to multiple projects).",
|
|
"type": "object",
|
|
"properties": {
|
|
"billingEnabled": {
|
|
"description": "True if the project is associated with an open billing account, to which\nusage on the project is charged. False if the project is associated with a\nclosed billing account, or no billing account at all, and therefore cannot\nuse paid services. This field is read-only.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "The resource name for the `ProjectBillingInfo`; has the form\n`projects/{project_id}/billingInfo`. For example, the resource name for the\nbilling information for project `tokyo-rain-123` would be\n`projects/tokyo-rain-123/billingInfo`. This field is read-only.",
|
|
"type": "string"
|
|
},
|
|
"projectId": {
|
|
"description": "The ID of the project that this `ProjectBillingInfo` represents, such as\n`tokyo-rain-123`. This is a convenience field so that you don't need to\nparse the `name` field to obtain a project ID. This field is read-only.",
|
|
"type": "string"
|
|
},
|
|
"billingAccountName": {
|
|
"description": "The resource name of the billing account associated with the project, if\nany. For example, `billingAccounts/012345-567890-ABCDEF`.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "ProjectBillingInfo"
|
|
},
|
|
"ListProjectBillingInfoResponse": {
|
|
"description": "Request message for `ListProjectBillingInfoResponse`.",
|
|
"type": "object",
|
|
"properties": {
|
|
"nextPageToken": {
|
|
"description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListProjectBillingInfo` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve.",
|
|
"type": "string"
|
|
},
|
|
"projectBillingInfo": {
|
|
"description": "A list of `ProjectBillingInfo` resources representing the projects\nassociated with the billing account.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "ProjectBillingInfo"
|
|
}
|
|
}
|
|
},
|
|
"id": "ListProjectBillingInfoResponse"
|
|
},
|
|
"ListBillingAccountsResponse": {
|
|
"description": "Response message for `ListBillingAccounts`.",
|
|
"type": "object",
|
|
"properties": {
|
|
"nextPageToken": {
|
|
"description": "A token to retrieve the next page of results. To retrieve the next page,\ncall `ListBillingAccounts` again with the `page_token` field set to this\nvalue. This field is empty if there are no more results to retrieve.",
|
|
"type": "string"
|
|
},
|
|
"billingAccounts": {
|
|
"description": "A list of billing accounts.",
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "BillingAccount"
|
|
}
|
|
}
|
|
},
|
|
"id": "ListBillingAccountsResponse"
|
|
},
|
|
"BillingAccount": {
|
|
"description": "A billing account in [Google Cloud\nConsole](https://console.cloud.google.com/). You can assign a billing account\nto one or more projects.",
|
|
"type": "object",
|
|
"properties": {
|
|
"displayName": {
|
|
"description": "The display name given to the billing account, such as `My Billing\nAccount`. This name is displayed in the Google Cloud Console.",
|
|
"type": "string"
|
|
},
|
|
"open": {
|
|
"description": "True if the billing account is open, and will therefore be charged for any\nusage on associated projects. False if the billing account is closed, and\ntherefore projects associated with it will be unable to use paid services.",
|
|
"type": "boolean"
|
|
},
|
|
"name": {
|
|
"description": "The resource name of the billing account. The resource name has the form\n`billingAccounts/{billing_account_id}`. For example,\n`billingAccounts/012345-567890-ABCDEF` would be the resource name for\nbilling account `012345-567890-ABCDEF`.",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"id": "BillingAccount"
|
|
}
|
|
},
|
|
"revision": "20170210",
|
|
"basePath": "",
|
|
"icons": {
|
|
"x32": "http://www.google.com/images/icons/product/search-32.gif",
|
|
"x16": "http://www.google.com/images/icons/product/search-16.gif"
|
|
},
|
|
"discoveryVersion": "v1",
|
|
"baseUrl": "https://cloudbilling.googleapis.com/",
|
|
"name": "cloudbilling",
|
|
"parameters": {
|
|
"access_token": {
|
|
"description": "OAuth access token.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"prettyPrint": {
|
|
"description": "Returns response with indentations and line breaks.",
|
|
"default": "true",
|
|
"type": "boolean",
|
|
"location": "query"
|
|
},
|
|
"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.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"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.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"pp": {
|
|
"description": "Pretty-print response.",
|
|
"default": "true",
|
|
"type": "boolean",
|
|
"location": "query"
|
|
},
|
|
"fields": {
|
|
"description": "Selector specifying which fields to include in a partial response.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"alt": {
|
|
"description": "Data format for response.",
|
|
"location": "query",
|
|
"enum": [
|
|
"json",
|
|
"media",
|
|
"proto"
|
|
],
|
|
"default": "json",
|
|
"enumDescriptions": [
|
|
"Responses with Content-Type of application/json",
|
|
"Media download with context-dependent Content-Type",
|
|
"Responses with Content-Type of application/x-protobuf"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"$.xgafv": {
|
|
"description": "V1 error format.",
|
|
"enum": [
|
|
"1",
|
|
"2"
|
|
],
|
|
"enumDescriptions": [
|
|
"v1 error format",
|
|
"v2 error format"
|
|
],
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"callback": {
|
|
"description": "JSONP",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"oauth_token": {
|
|
"description": "OAuth 2.0 token for the current user.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"uploadType": {
|
|
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"bearer_token": {
|
|
"description": "OAuth bearer token.",
|
|
"type": "string",
|
|
"location": "query"
|
|
},
|
|
"upload_protocol": {
|
|
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
|
"type": "string",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"documentationLink": "https://cloud.google.com/billing/",
|
|
"ownerDomain": "google.com",
|
|
"batchPath": "batch",
|
|
"servicePath": "",
|
|
"ownerName": "Google",
|
|
"version": "v1",
|
|
"rootUrl": "https://cloudbilling.googleapis.com/",
|
|
"kind": "discovery#restDescription"
|
|
}
|