Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / cloudbilling_v1.projects.html
blob: 745f61067dd2b6bb69c65d179b9c1300121fc1b7 [file] [log] [blame]
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="cloudbilling_v1.html">Cloud Billing API</a> . <a href="cloudbilling_v1.projects.html">projects</a></h1>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]78 <code><a href="#getBillingInfo">getBillingInfo(name, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]79<p class="firstline">Gets the billing information for a project. The current authenticated user</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#updateBillingInfo">updateBillingInfo(name, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]82<p class="firstline">Sets or updates the billing account associated with a project. You specify</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]83<h3>Method Details</h3>
84<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]85 <code class="details" id="getBillingInfo">getBillingInfo(name, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]86 <pre>Gets the billing information for a project. The current authenticated user
87must have [permission to view the
88project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo
89).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]90
91Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]92 name: string, Required. The resource name of the project for which billing information is
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]93retrieved. For example, `projects/tokyo-rain-123`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]94 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]95 Allowed values
96 1 - v1 error format
97 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]98
99Returns:
100 An object of the form:
101
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102 { # Encapsulation of billing information for a GCP Console project. A project
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]103 # has at most one associated billing account at a time (but a billing account
104 # can be assigned to multiple projects).
105 "projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as
106 # `tokyo-rain-123`. This is a convenience field so that you don't need to
107 # parse the `name` field to obtain a project ID. This field is read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 "billingAccountName": "A String", # The resource name of the billing account associated with the project, if
109 # any. For example, `billingAccounts/012345-567890-ABCDEF`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]110 "billingEnabled": True or False, # True if the project is associated with an open billing account, to which
111 # usage on the project is charged. False if the project is associated with a
112 # closed billing account, or no billing account at all, and therefore cannot
113 # use paid services. This field is read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]114 "name": "A String", # The resource name for the `ProjectBillingInfo`; has the form
115 # `projects/{project_id}/billingInfo`. For example, the resource name for the
116 # billing information for project `tokyo-rain-123` would be
117 # `projects/tokyo-rain-123/billingInfo`. This field is read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]118 }</pre>
119</div>
120
121<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122 <code class="details" id="updateBillingInfo">updateBillingInfo(name, body=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]123 <pre>Sets or updates the billing account associated with a project. You specify
124the new billing account by setting the `billing_account_name` in the
125`ProjectBillingInfo` resource to the resource name of a billing account.
126Associating a project with an open billing account enables billing on the
127project and allows charges for resource usage. If the project already had a
128billing account, this method changes the billing account used for resource
129usage charges.
130
131*Note:* Incurred charges that have not yet been reported in the transaction
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132history of the GCP Console might be billed to the new billing
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]133account, even if the charge occurred before the new billing account was
134assigned to the project.
135
136The current authenticated user must have ownership privileges for both the
137[project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo
138) and the [billing
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139account](https://cloud.google.com/billing/docs/how-to/billing-access).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]140
141You can disable billing on the project by setting the
142`billing_account_name` field to empty. This action disassociates the
143current billing account from the project. Any billable activity of your
144in-use services will stop, and your application could stop functioning as
145expected. Any unbilled charges to date will be billed to the previously
146associated account. The current authenticated user must be either an owner
147of the project or an owner of the billing account for the project.
148
149Note that associating a project with a *closed* billing account will have
150much the same effect as disabling billing on the project: any paid
151resources used by the project will be shut down. Thus, unless you wish to
152disable billing, you should always call this method with the name of an
153*open* billing account.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]154
155Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]156 name: string, Required. The resource name of the project associated with the billing information
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]157that you want to update. For example, `projects/tokyo-rain-123`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]158 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]159 The object takes the form of:
160
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161{ # Encapsulation of billing information for a GCP Console project. A project
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]162 # has at most one associated billing account at a time (but a billing account
163 # can be assigned to multiple projects).
164 "projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as
165 # `tokyo-rain-123`. This is a convenience field so that you don't need to
166 # parse the `name` field to obtain a project ID. This field is read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]167 "billingAccountName": "A String", # The resource name of the billing account associated with the project, if
168 # any. For example, `billingAccounts/012345-567890-ABCDEF`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]169 "billingEnabled": True or False, # True if the project is associated with an open billing account, to which
170 # usage on the project is charged. False if the project is associated with a
171 # closed billing account, or no billing account at all, and therefore cannot
172 # use paid services. This field is read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]173 "name": "A String", # The resource name for the `ProjectBillingInfo`; has the form
174 # `projects/{project_id}/billingInfo`. For example, the resource name for the
175 # billing information for project `tokyo-rain-123` would be
176 # `projects/tokyo-rain-123/billingInfo`. This field is read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]177}
178
179 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]180 Allowed values
181 1 - v1 error format
182 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]183
184Returns:
185 An object of the form:
186
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]187 { # Encapsulation of billing information for a GCP Console project. A project
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]188 # has at most one associated billing account at a time (but a billing account
189 # can be assigned to multiple projects).
190 "projectId": "A String", # The ID of the project that this `ProjectBillingInfo` represents, such as
191 # `tokyo-rain-123`. This is a convenience field so that you don't need to
192 # parse the `name` field to obtain a project ID. This field is read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]193 "billingAccountName": "A String", # The resource name of the billing account associated with the project, if
194 # any. For example, `billingAccounts/012345-567890-ABCDEF`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]195 "billingEnabled": True or False, # True if the project is associated with an open billing account, to which
196 # usage on the project is charged. False if the project is associated with a
197 # closed billing account, or no billing account at all, and therefore cannot
198 # use paid services. This field is read-only.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]199 "name": "A String", # The resource name for the `ProjectBillingInfo`; has the form
200 # `projects/{project_id}/billingInfo`. For example, the resource name for the
201 # billing information for project `tokyo-rain-123` would be
202 # `projects/tokyo-rain-123/billingInfo`. This field is read-only.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]203 }</pre>
204</div>
205
206</body></html>