Documentation

Google_Service_Cloudbilling_Resource_BillingAccounts extends Google_Service_Resource
in package

The "billingAccounts" collection of methods.

Typical usage is: $cloudbillingService = new Google_Service_Cloudbilling(...); $billingAccounts = $cloudbillingService->billingAccounts;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
create()  : Google_Service_Cloudbilling_BillingAccount
Creates a billing account. This method can only be used to create [billing subaccounts](https://cloud.google.com/billing/docs/concepts) by Google Cloud resellers. When creating a subaccount, the current authenticated user must have the `billing.accounts.update` IAM permission on the master account, which is typically given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing- access). This method will return an error if the master account has not been provisioned as a reseller account. (billingAccounts.create)
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Cloudbilling_BillingAccount
Gets information about a billing account. The current authenticated user must be a [viewer of the billing account](https://cloud.google.com/billing/docs /how-to/billing-access). (billingAccounts.get)
getIamPolicy()  : Google_Service_Cloudbilling_Policy
Gets the access control policy for a billing account. The caller must have the `billing.accounts.getIamPolicy` permission on the account, which is often given to billing account [viewers](https://cloud.google.com/billing/docs/how- to/billing-access). (billingAccounts.getIamPolicy)
listBillingAccounts()  : Google_Service_Cloudbilling_ListBillingAccountsResponse
Lists the billing accounts that the current authenticated user has permission to [view](https://cloud.google.com/billing/docs/how-to/billing-access).
patch()  : Google_Service_Cloudbilling_BillingAccount
Updates a billing account's fields. Currently the only field that can be edited is `display_name`. The current authenticated user must have the `billing.accounts.update` IAM permission, which is typically given to the [administrator](https://cloud.google.com/billing/docs/how-to/billing-access) of the billing account. (billingAccounts.patch)
setIamPolicy()  : Google_Service_Cloudbilling_Policy
Sets the access control policy for a billing account. Replaces any existing policy. The caller must have the `billing.accounts.setIamPolicy` permission on the account, which is often given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing- access). (billingAccounts.setIamPolicy)
testIamPermissions()  : Google_Service_Cloudbilling_TestIamPermissionsResponse
Tests the access control policy for a billing account. This method takes the resource and a set of permissions as input and returns the subset of the input permissions that the caller is allowed for that resource.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass

create()

Creates a billing account. This method can only be used to create [billing subaccounts](https://cloud.google.com/billing/docs/concepts) by Google Cloud resellers. When creating a subaccount, the current authenticated user must have the `billing.accounts.update` IAM permission on the master account, which is typically given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing- access). This method will return an error if the master account has not been provisioned as a reseller account. (billingAccounts.create)

public create(Google_Service_Cloudbilling_BillingAccount $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Cloudbilling_BillingAccount
Parameters
$postBody : Google_Service_Cloudbilling_BillingAccount
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Cloudbilling_BillingAccount

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string

$requestUrl

get()

Gets information about a billing account. The current authenticated user must be a [viewer of the billing account](https://cloud.google.com/billing/docs /how-to/billing-access). (billingAccounts.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Cloudbilling_BillingAccount
Parameters
$name : string

Required. The resource name of the billing account to retrieve. For example, billingAccounts/012345-567890-ABCDEF.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Cloudbilling_BillingAccount

getIamPolicy()

Gets the access control policy for a billing account. The caller must have the `billing.accounts.getIamPolicy` permission on the account, which is often given to billing account [viewers](https://cloud.google.com/billing/docs/how- to/billing-access). (billingAccounts.getIamPolicy)

public getIamPolicy(string $resource[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Cloudbilling_Policy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

int options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- policies).

Return values
Google_Service_Cloudbilling_Policy

listBillingAccounts()

Lists the billing accounts that the current authenticated user has permission to [view](https://cloud.google.com/billing/docs/how-to/billing-access).

public listBillingAccounts([array<string|int, mixed> $optParams = array() ]) : Google_Service_Cloudbilling_ListBillingAccountsResponse

(billingAccounts.listBillingAccounts)

Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken 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.

opt_param

string filter Options for how to filter the returned billing accounts. Currently this only supports filtering for subaccounts under a single provided reseller billing account. (e.g. "master_billing_account=billingAccounts/012345-678901-ABCDEF"). Boolean algebra and other fields are not currently supported.

opt_param

int pageSize Requested page size. The maximum page size is 100; this is also the default.

Return values
Google_Service_Cloudbilling_ListBillingAccountsResponse

patch()

Updates a billing account's fields. Currently the only field that can be edited is `display_name`. The current authenticated user must have the `billing.accounts.update` IAM permission, which is typically given to the [administrator](https://cloud.google.com/billing/docs/how-to/billing-access) of the billing account. (billingAccounts.patch)

public patch(string $name, Google_Service_Cloudbilling_BillingAccount $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Cloudbilling_BillingAccount
Parameters
$name : string

Required. The name of the billing account resource to be updated.

$postBody : Google_Service_Cloudbilling_BillingAccount
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask The update mask applied to the resource. Only "display_name" is currently supported.

Return values
Google_Service_Cloudbilling_BillingAccount

setIamPolicy()

Sets the access control policy for a billing account. Replaces any existing policy. The caller must have the `billing.accounts.setIamPolicy` permission on the account, which is often given to billing account [administrators](https://cloud.google.com/billing/docs/how-to/billing- access). (billingAccounts.setIamPolicy)

public setIamPolicy(string $resource, Google_Service_Cloudbilling_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Cloudbilling_Policy
Parameters
$resource : string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

$postBody : Google_Service_Cloudbilling_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Cloudbilling_Policy

testIamPermissions()

Tests the access control policy for a billing account. This method takes the resource and a set of permissions as input and returns the subset of the input permissions that the caller is allowed for that resource.

public testIamPermissions(string $resource, Google_Service_Cloudbilling_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Cloudbilling_TestIamPermissionsResponse

(billingAccounts.testIamPermissions)

Parameters
$resource : string

REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

$postBody : Google_Service_Cloudbilling_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Cloudbilling_TestIamPermissionsResponse

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed

Search results