blob: f7dae92b42f16c03fc809aa2f39f91970efcea60 [file] [log] [blame]
<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">Google Cloud Billing API</a> . <a href="cloudbilling_v1.billingAccounts.html">billingAccounts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="cloudbilling_v1.billingAccounts.projects.html">projects()</a></code>
</p>
<p class="firstline">Returns the projects Resource.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about a billing account. The current authenticated user</p>
<p class="toc_element">
<code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the billing accounts that the current authenticated user</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<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).
Args:
name: string, The resource name of the billing account to retrieve. For example,
`billingAccounts/012345-567890-ABCDEF`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A billing account in [Google Cloud
# Console](https://console.cloud.google.com/). You can assign a billing account
# to one or more projects.
"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.
"displayName": "A String", # The display name given to the billing account, such as `My Billing
# Account`. This name is displayed in the Google Cloud Console.
"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`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the billing accounts that the current authenticated user
[owns](https://support.google.com/cloud/answer/4430947).
Args:
pageSize: integer, Requested page size. The maximum page size is 100; this is also the
default.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for `ListBillingAccounts`.
"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.
"billingAccounts": [ # A list of billing accounts.
{ # A billing account in [Google Cloud
# Console](https://console.cloud.google.com/). You can assign a billing account
# to one or more projects.
"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.
"displayName": "A String", # The display name given to the billing account, such as `My Billing
# Account`. This name is displayed in the Google Cloud Console.
"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`.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>