docs/dyn/cloudbilling_v1.projects.html - platform/external/python/google-api-python-client - Git at Google

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <h1><a href="cloudbilling_v1.html">Cloud Billing API</a> . <a href="cloudbilling_v1.projects.html">projects</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#getBillingInfo">getBillingInfo(name, x__xgafv=None)</a></code></p>
 <p class="firstline">Gets the billing information for a project. The current authenticated user</p>
 <p class="toc_element">
   <code><a href="#updateBillingInfo">updateBillingInfo(name, body, x__xgafv=None)</a></code></p>
 <p class="firstline">Sets or updates the billing account associated with a project. You specify</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="getBillingInfo">getBillingInfo(name, x__xgafv=None)</code>
   <pre>Gets the billing information for a project. The current authenticated user
 must have [permission to view the
 project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo
 ).

 Args:
   name: string, The resource name of the project for which billing information is
 retrieved. For example, `projects/tokyo-rain-123`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # Encapsulation of billing information for a GCP Console project. A project
       # has at most one associated billing account at a time (but a billing account
       # can be assigned to multiple projects).
     "projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as
         # `tokyo-rain-123`. This is a convenience field so that you don't need to
         # parse the `name` field to obtain a project ID. This field is read-only.
     "name": "A String", # The resource name for the `ProjectBillingInfo`; has the form
         # `projects/{project_id}/billingInfo`. For example, the resource name for the
         # billing information for project `tokyo-rain-123` would be
         # `projects/tokyo-rain-123/billingInfo`. This field is read-only.
     "billingEnabled": True or False, # True if the project is associated with an open billing account, to which
         # usage on the project is charged. False if the project is associated with a
         # closed billing account, or no billing account at all, and therefore cannot
         # use paid services. This field is read-only.
     "billingAccountName": "A String", # The resource name of the billing account associated with the project, if
         # any. For example, `billingAccounts/012345-567890-ABCDEF`.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="updateBillingInfo">updateBillingInfo(name, body, x__xgafv=None)</code>
   <pre>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 GCP 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](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo
 ) and the [billing
 account](https://cloud.google.com/billing/docs/how-to/billing-access).

 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.

 Args:
   name: string, The resource name of the project associated with the billing information
 that you want to update. For example, `projects/tokyo-rain-123`. (required)
   body: object, The request body. (required)
     The object takes the form of:

 { # Encapsulation of billing information for a GCP Console project. A project
     # has at most one associated billing account at a time (but a billing account
     # can be assigned to multiple projects).
   "projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as
       # `tokyo-rain-123`. This is a convenience field so that you don't need to
       # parse the `name` field to obtain a project ID. This field is read-only.
   "name": "A String", # The resource name for the `ProjectBillingInfo`; has the form
       # `projects/{project_id}/billingInfo`. For example, the resource name for the
       # billing information for project `tokyo-rain-123` would be
       # `projects/tokyo-rain-123/billingInfo`. This field is read-only.
   "billingEnabled": True or False, # True if the project is associated with an open billing account, to which
       # usage on the project is charged. False if the project is associated with a
       # closed billing account, or no billing account at all, and therefore cannot
       # use paid services. This field is read-only.
   "billingAccountName": "A String", # The resource name of the billing account associated with the project, if
       # any. For example, `billingAccounts/012345-567890-ABCDEF`.
 }

   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # Encapsulation of billing information for a GCP Console project. A project
       # has at most one associated billing account at a time (but a billing account
       # can be assigned to multiple projects).
     "projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as
         # `tokyo-rain-123`. This is a convenience field so that you don't need to
         # parse the `name` field to obtain a project ID. This field is read-only.
     "name": "A String", # The resource name for the `ProjectBillingInfo`; has the form
         # `projects/{project_id}/billingInfo`. For example, the resource name for the
         # billing information for project `tokyo-rain-123` would be
         # `projects/tokyo-rain-123/billingInfo`. This field is read-only.
     "billingEnabled": True or False, # True if the project is associated with an open billing account, to which
         # usage on the project is charged. False if the project is associated with a
         # closed billing account, or no billing account at all, and therefore cannot
         # use paid services. This field is read-only.
     "billingAccountName": "A String", # The resource name of the billing account associated with the project, if
         # any. For example, `billingAccounts/012345-567890-ABCDEF`.
   }</pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<h1><a href="cloudbilling_v1.html">Cloud Billing API</a> . <a href="cloudbilling_v1.projects.html">projects</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#getBillingInfo">getBillingInfo(name, x__xgafv=None)</a></code></p>
	<p class="firstline">Gets the billing information for a project. The current authenticated user</p>
	<p class="toc_element">
	<code><a href="#updateBillingInfo">updateBillingInfo(name, body, x__xgafv=None)</a></code></p>
	<p class="firstline">Sets or updates the billing account associated with a project. You specify</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="getBillingInfo">getBillingInfo(name, x__xgafv=None)</code>
	<pre>Gets the billing information for a project. The current authenticated user
	must have [permission to view the
	project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo
	).

	Args:
	name: string, The resource name of the project for which billing information is
	retrieved. For example, `projects/tokyo-rain-123`. (required)
	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # Encapsulation of billing information for a GCP Console project. A project
	# has at most one associated billing account at a time (but a billing account
	# can be assigned to multiple projects).
	"projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as
	# `tokyo-rain-123`. This is a convenience field so that you don't need to
	# parse the `name` field to obtain a project ID. This field is read-only.
	"name": "A String", # The resource name for the `ProjectBillingInfo`; has the form
	# `projects/{project_id}/billingInfo`. For example, the resource name for the
	# billing information for project `tokyo-rain-123` would be
	# `projects/tokyo-rain-123/billingInfo`. This field is read-only.
	"billingEnabled": True or False, # True if the project is associated with an open billing account, to which
	# usage on the project is charged. False if the project is associated with a
	# closed billing account, or no billing account at all, and therefore cannot
	# use paid services. This field is read-only.
	"billingAccountName": "A String", # The resource name of the billing account associated with the project, if
	# any. For example, `billingAccounts/012345-567890-ABCDEF`.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="updateBillingInfo">updateBillingInfo(name, body, x__xgafv=None)</code>
	<pre>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 GCP 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](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo
	) and the [billing
	account](https://cloud.google.com/billing/docs/how-to/billing-access).

	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.

	Args:
	name: string, The resource name of the project associated with the billing information
	that you want to update. For example, `projects/tokyo-rain-123`. (required)
	body: object, The request body. (required)
	The object takes the form of:

	{ # Encapsulation of billing information for a GCP Console project. A project
	# has at most one associated billing account at a time (but a billing account
	# can be assigned to multiple projects).
	"projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as
	# `tokyo-rain-123`. This is a convenience field so that you don't need to
	# parse the `name` field to obtain a project ID. This field is read-only.
	"name": "A String", # The resource name for the `ProjectBillingInfo`; has the form
	# `projects/{project_id}/billingInfo`. For example, the resource name for the
	# billing information for project `tokyo-rain-123` would be
	# `projects/tokyo-rain-123/billingInfo`. This field is read-only.
	"billingEnabled": True or False, # True if the project is associated with an open billing account, to which
	# usage on the project is charged. False if the project is associated with a
	# closed billing account, or no billing account at all, and therefore cannot
	# use paid services. This field is read-only.
	"billingAccountName": "A String", # The resource name of the billing account associated with the project, if
	# any. For example, `billingAccounts/012345-567890-ABCDEF`.
	}

	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # Encapsulation of billing information for a GCP Console project. A project
	# has at most one associated billing account at a time (but a billing account
	# can be assigned to multiple projects).
	"projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as
	# `tokyo-rain-123`. This is a convenience field so that you don't need to
	# parse the `name` field to obtain a project ID. This field is read-only.
	"name": "A String", # The resource name for the `ProjectBillingInfo`; has the form
	# `projects/{project_id}/billingInfo`. For example, the resource name for the
	# billing information for project `tokyo-rain-123` would be
	# `projects/tokyo-rain-123/billingInfo`. This field is read-only.
	"billingEnabled": True or False, # True if the project is associated with an open billing account, to which
	# usage on the project is charged. False if the project is associated with a
	# closed billing account, or no billing account at all, and therefore cannot
	# use paid services. This field is read-only.
	"billingAccountName": "A String", # The resource name of the billing account associated with the project, if
	# any. For example, `billingAccounts/012345-567890-ABCDEF`.
	}</pre>
	</div>

	</body></html>