View Source GoogleApi.CloudBilling.V1.Api.Organizations (google_api_cloud_billing v0.24.1)

API calls for all endpoints tagged Organizations.

Summary

Functions

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.

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

Functions

Link to this function

cloudbilling_organizations_billing_accounts_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec cloudbilling_organizations_billing_accounts_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudBilling.V1.Model.BillingAccount.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

  • connection (type: GoogleApi.CloudBilling.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Optional. The parent to create a billing account from. Format: - billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.CloudBilling.V1.Model.BillingAccount.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudBilling.V1.Model.BillingAccount{}} on success
  • {:error, info} on failure
Link to this function

cloudbilling_organizations_billing_accounts_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec cloudbilling_organizations_billing_accounts_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudBilling.V1.Model.ListBillingAccountsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.CloudBilling.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Optional. The parent resource to list billing accounts from. Format: - organizations/{organization_id}, for example, organizations/12345678 - billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Options for how to filter the returned billing accounts. This only supports filtering for subaccounts under a single provided parent billing account. (for example, master_billing_account=billingAccounts/012345-678901-ABCDEF). Boolean algebra and other fields are not currently supported.
    • :pageSize (type: integer()) - Requested page size. The maximum page size is 100; this is also the default.
    • :pageToken (type: String.t) - 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudBilling.V1.Model.ListBillingAccountsResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudbilling_organizations_billing_accounts_move(connection, destination_parent, name, optional_params \\ [], opts \\ [])

View Source
@spec cloudbilling_organizations_billing_accounts_move(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudBilling.V1.Model.BillingAccount.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Changes which parent organization a billing account belongs to.

Parameters

  • connection (type: GoogleApi.CloudBilling.V1.Connection.t) - Connection to server
  • destination_parent (type: String.t) - Required. The resource name of the Organization to move the billing account under. Must be of the form organizations/{organization_id}.
  • name (type: String.t) - Required. The resource name of the billing account to move. Must be of the form billingAccounts/{billing_account_id}. The specified billing account cannot be a subaccount, since a subaccount always belongs to the same organization as its parent account.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudBilling.V1.Model.BillingAccount{}} on success
  • {:error, info} on failure