Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0669410c6b2c48884ae31671b9d710a9ff6346c6 / . / docs / dyn / cloudbilling_v1.billingAccounts.html
blob: e6b6ca3757e8e3131f17ed2814e08e0d385c6ee2 [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">
83 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
84<p class="firstline">Gets information about a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).</p>
85<p class="toc_element">
86 <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
87<p class="firstline">Lists the billing accounts that the current authenticated user [owns](https://support.google.com/cloud/answer/4430947).</p>
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">
93 <code class="details" id="get">get(name, x__xgafv=None)</code>
94 <pre>Gets information about a billing account. The current authenticated user must be an [owner of the billing account](https://support.google.com/cloud/answer/4430947).
95
96Args:
97 name: string, The resource name of the billing account to retrieve. For example, `billingAccounts/012345-567890-ABCDEF`. (required)
98 x__xgafv: string, V1 error format.
99
100Returns:
101 An object of the form:
102
103 { # A billing account in [Google Developers Console](https://console.developers.google.com/). You can assign a billing account to one or more projects.
104 "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Developers Console.
105 "open": True or False, # True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.
106 "name": "A String", # The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`.
107 }</pre>
108</div>
109
110<div class="method">
111 <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
112 <pre>Lists the billing accounts that the current authenticated user [owns](https://support.google.com/cloud/answer/4430947).
113
114Args:
115 pageSize: integer, Requested page size. The maximum page size is 100; this is also the default.
116 pageToken: string, A token identifying a page of results to return. This should be a `next_page_token` value returned from a previous `ListBillingAccounts` call. If unspecified, the first page of results is returned.
117 x__xgafv: string, V1 error format.
118
119Returns:
120 An object of the form:
121
122 { # Response message for `ListBillingAccounts`.
123 "nextPageToken": "A String", # A token to retrieve the next page of results. To retrieve the next page, call `ListBillingAccounts` again with the `page_token` field set to this value. This field is empty if there are no more results to retrieve.
124 "billingAccounts": [ # A list of billing accounts.
125 { # A billing account in [Google Developers Console](https://console.developers.google.com/). You can assign a billing account to one or more projects.
126 "displayName": "A String", # The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Developers Console.
127 "open": True or False, # True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services.
128 "name": "A String", # The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`.
129 },
130 ],
131 }</pre>
132</div>
133
134<div class="method">
135 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
136 <pre>Retrieves the next page of results.
137
138Args:
139 previous_request: The request for the previous page. (required)
140 previous_response: The response from the request for the previous page. (required)
141
142Returns:
143 A request object that you can call 'execute()' on to request the next
144 page. Returns None if there are no more items in the collection.
145 </pre>
146</div>
147
148</body></html>