Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 2f245374da9c895dbd8bb0423e98707d51b53414 / . / docs / dyn / cloudbilling_v1.billingAccounts.html
blob: f7dae92b42f16c03fc809aa2f39f91970efcea60 [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
75<h1><a href="cloudbilling_v1.html">Google Cloud Billing API</a> . <a href="cloudbilling_v1.billingAccounts.html">billingAccounts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="cloudbilling_v1.billingAccounts.projects.html">projects()</a></code>
79</p>
80<p class="firstline">Returns the projects Resource.</p>
81
82<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]83 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]84<p class="firstline">Gets information about a billing account. The current authenticated user</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]85<p class="toc_element">
86 <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]87<p class="firstline">Lists the billing accounts that the current authenticated user</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]88<p class="toc_element">
89 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
90<p class="firstline">Retrieves the next page of results.</p>
91<h3>Method Details</h3>
92<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]93 <code class="details" id="get">get(name, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]94 <pre>Gets information about a billing account. The current authenticated user
95must be an [owner of the billing
96account](https://support.google.com/cloud/answer/4430947).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]97
98Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]99 name: string, The resource name of the billing account to retrieve. For example,
100`billingAccounts/012345-567890-ABCDEF`. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]101 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]105
106Returns:
107 An object of the form:
108
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]109 { # A billing account in [Google Cloud
110 # Console](https://console.cloud.google.com/). You can assign a billing account
111 # to one or more projects.
112 "open": True or False, # True if the billing account is open, and will therefore be charged for any
113 # usage on associated projects. False if the billing account is closed, and
114 # therefore projects associated with it will be unable to use paid services.
115 "displayName": "A String", # The display name given to the billing account, such as `My Billing
116 # Account`. This name is displayed in the Google Cloud Console.
117 "name": "A String", # The resource name of the billing account. The resource name has the form
118 # `billingAccounts/{billing_account_id}`. For example,
119 # `billingAccounts/012345-567890-ABCDEF` would be the resource name for
120 # billing account `012345-567890-ABCDEF`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]121 }</pre>
122</div>
123
124<div class="method">
125 <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]126 <pre>Lists the billing accounts that the current authenticated user
127[owns](https://support.google.com/cloud/answer/4430947).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]128
129Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]130 pageSize: integer, Requested page size. The maximum page size is 100; this is also the
131default.
132 pageToken: string, A token identifying a page of results to return. This should be a
133`next_page_token` value returned from a previous `ListBillingAccounts`
134call. If unspecified, the first page of results is returned.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]135 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]136 Allowed values
137 1 - v1 error format
138 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]139
140Returns:
141 An object of the form:
142
143 { # Response message for `ListBillingAccounts`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]144 "nextPageToken": "A String", # A token to retrieve the next page of results. To retrieve the next page,
145 # call `ListBillingAccounts` again with the `page_token` field set to this
146 # value. This field is empty if there are no more results to retrieve.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]147 "billingAccounts": [ # A list of billing accounts.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]148 { # A billing account in [Google Cloud
149 # Console](https://console.cloud.google.com/). You can assign a billing account
150 # to one or more projects.
151 "open": True or False, # True if the billing account is open, and will therefore be charged for any
152 # usage on associated projects. False if the billing account is closed, and
153 # therefore projects associated with it will be unable to use paid services.
154 "displayName": "A String", # The display name given to the billing account, such as `My Billing
155 # Account`. This name is displayed in the Google Cloud Console.
156 "name": "A String", # The resource name of the billing account. The resource name has the form
157 # `billingAccounts/{billing_account_id}`. For example,
158 # `billingAccounts/012345-567890-ABCDEF` would be the resource name for
159 # billing account `012345-567890-ABCDEF`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]160 },
161 ],
162 }</pre>
163</div>
164
165<div class="method">
166 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
167 <pre>Retrieves the next page of results.
168
169Args:
170 previous_request: The request for the previous page. (required)
171 previous_response: The response from the request for the previous page. (required)
172
173Returns:
174 A request object that you can call 'execute()' on to request the next
175 page. Returns None if there are no more items in the collection.
176 </pre>
177</div>
178
179</body></html>