Billing V1 API - Class Google::Cloud::Billing::V1::BillingAccount (v1.1.0)

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

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#currency_code

def currency_code() -> ::String
Returns
  • (::String) — Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as USD.

    Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account.

#currency_code=

def currency_code=(value) -> ::String
Parameter
  • value (::String) — Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as USD.

    Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account.

Returns
  • (::String) — Optional. The currency in which the billing account is billed and charged, represented as an ISO 4217 code such as USD.

    Billing account currency is determined at the time of billing account creation and cannot be updated subsequently, so this field should not be set on update requests. In addition, a subaccount always matches the currency of its parent billing account, so this field should not be set on subaccount creation requests. Clients can read this field to determine the currency of an existing billing account.

#display_name

def display_name() -> ::String
Returns
  • (::String) — The display name given to the billing account, such as My Billing Account. This name is displayed in the Google Cloud Console.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — The display name given to the billing account, such as My Billing Account. This name is displayed in the Google Cloud Console.
Returns
  • (::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

def master_billing_account() -> ::String
Returns
  • (::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.

#master_billing_account=

def master_billing_account=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#name

def name() -> ::String
Returns
  • (::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

def open() -> ::Boolean
Returns
  • (::Boolean) — 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.

#parent

def parent() -> ::String
Returns
  • (::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