Google Cloud Billing V1 Client - Class BillingAccount (2.0.0-RC1)

Reference documentation and code samples for the Google Cloud Billing V1 Client class BillingAccount.

A billing account in the Google Cloud Console. You can assign a billing account to one or more projects.

Generated from protobuf message google.cloud.billing.v1.BillingAccount

Namespace

Google \ Cloud \ Billing \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. 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.
↳ open bool

Output only. 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 are unable to use paid services.
↳ display_name string

The display name given to the billing account, such as My Billing Account. This name is displayed in the Google Cloud Console.
↳ master_billing_account string

If this account is a subaccount, then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.
↳ parent string

Output only. The billing account's parent resource identifier. Use the MoveBillingAccount method to update the account's parent resource if it is a organization. Format: - organizations/{organization_id}, for example, organizations/12345678 - billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF

getName

Output only. 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.

Returns
Type Description
string

setName

Output only. 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.

Parameter
Name Description
var string
Returns
Type Description
$this

getOpen

Output only. 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 are unable to use paid services.

Returns
Type Description
bool

setOpen

Output only. 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 are unable to use paid services.

Parameter
Name Description
var bool
Returns
Type Description
$this

getDisplayName

The display name given to the billing account, such as My Billing Account. This name is displayed in the Google Cloud Console.

Returns
Type Description
string

setDisplayName

The display name given to the billing account, such as My Billing Account. This name is displayed in the Google Cloud Console.

Parameter
Name Description
var string
Returns
Type Description
$this

getMasterBillingAccount

If this account is a subaccount, then this will be the resource name of the parent billing account that it is being resold through.

Otherwise this will be empty.

Returns
Type Description
string

setMasterBillingAccount

If this account is a subaccount, then this will be the resource name of the parent billing account that it is being resold through.

Otherwise this will be empty.

Parameter
Name Description
var string
Returns
Type Description
$this

getParent

Output only. The billing account's parent resource identifier.

Use the MoveBillingAccount method to update the account's parent resource if it is a organization. Format:

  • organizations/{organization_id}, for example, organizations/12345678
  • billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF
Returns
Type Description
string

setParent

Output only. The billing account's parent resource identifier.

Use the MoveBillingAccount method to update the account's parent resource if it is a organization. Format:

  • organizations/{organization_id}, for example, organizations/12345678
  • billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF
Parameter
Name Description
var string
Returns
Type Description
$this