sub_accounts

Creates, updates, deletes, gets or lists a sub_accounts resource.

Overview

Name	sub_accounts
Type	Resource
Id	google.cloudbilling.sub_accounts

Fields

The following fields are returned by SELECT queries:

list

Successful response

Name	Datatype	Description
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.
currencyCode	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.
displayName	string	The display name given to the billing account, such as My Billing Account. This name is displayed in the Google Cloud Console.
masterBillingAccount	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.
open	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	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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	billingAccountsId	pageSize, pageToken, filter	Lists the billing accounts that the current authenticated user has permission to view.
create	insert	billingAccountsId		This method creates billing subaccounts. Google Cloud resellers should use the Channel Services APIs, accounts.customers.create and accounts.customers.entitlements.create. When creating a subaccount, the current authenticated user must have the billing.accounts.update IAM permission on the parent account, which is typically given to billing account administrators. This method will return an error if the parent account has not been provisioned for subaccounts.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
billingAccountsId	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

list

Lists the billing accounts that the current authenticated user has permission to view.

SELECT
name,
currencyCode,
displayName,
masterBillingAccount,
open,
parent
FROM google.cloudbilling.sub_accounts
WHERE billingAccountsId = '{{ billingAccountsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}';

INSERT examples

create

This method creates billing subaccounts. Google Cloud resellers should use the Channel Services APIs, accounts.customers.create and accounts.customers.entitlements.create. When creating a subaccount, the current authenticated user must have the billing.accounts.update IAM permission on the parent account, which is typically given to billing account administrators. This method will return an error if the parent account has not been provisioned for subaccounts.

INSERT INTO google.cloudbilling.sub_accounts (
data__displayName,
data__masterBillingAccount,
data__currencyCode,
billingAccountsId
)
SELECT 
'{{ displayName }}',
'{{ masterBillingAccount }}',
'{{ currencyCode }}',
'{{ billingAccountsId }}'
RETURNING
name,
currencyCode,
displayName,
masterBillingAccount,
open,
parent
;

Manifest

# Description fields are for documentation purposes
- name: sub_accounts
  props:
    - name: billingAccountsId
      value: string
      description: Required parameter for the sub_accounts resource.
    - name: displayName
      value: string
      description: >
        The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console.
        
    - name: masterBillingAccount
      value: string
      description: >
        If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty.
        
    - name: currencyCode
      value: string
      description: >
        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.