Class CloudBillingClient (1.4.1)

CloudBillingClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.billing_v1.services.cloud_billing.transports.base.CloudBillingTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Retrieves GCP Console billing accounts and associates them with projects.

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
`CloudBillingTransport`	The transport used by the client instance.

Methods

CloudBillingClient

CloudBillingClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.billing_v1.services.cloud_billing.transports.base.CloudBillingTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the cloud billing client.

Parameters

Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, CloudBillingTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions

Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

exit

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_billing_account

create_billing_account(request: Optional[Union[google.cloud.billing_v1.types.cloud_billing.CreateBillingAccountRequest, dict]] = None, *, billing_account: Optional[google.cloud.billing_v1.types.cloud_billing.BillingAccount] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a billing account. This method can only be used to create billing subaccounts <https://cloud.google.com/billing/docs/concepts> by GCP 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.

Parameters

Name	Description
`request`	`Union[google.cloud.billing_v1.types.CreateBillingAccountRequest, dict]` The request object. Request message for `CreateBillingAccount`.
`billing_account`	`google.cloud.billing_v1.types.BillingAccount` Required. The billing account resource to create. Currently CreateBillingAccount only supports subaccount creation, so any created billing accounts must be under a provided master billing account. This corresponds to the `billing_account` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.billing_v1.types.BillingAccount`	A billing account in [GCP Console](\ https://console.cloud.google.com/). You can assign a billing account to one or more projects.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
`filename`	`str` The path to the service account private key json file.

Returns

Type	Description
`CloudBillingClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter

Name	Description
`info`	`dict` The service account private key info.

Returns

Type	Description
`CloudBillingClient`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
`filename`	`str` The path to the service account private key json file.

Returns

Type	Description
`CloudBillingClient`	The constructed client.

get_billing_account

get_billing_account(request: Optional[Union[google.cloud.billing_v1.types.cloud_billing.GetBillingAccountRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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>__.

Parameters

Name	Description
`request`	`Union[google.cloud.billing_v1.types.GetBillingAccountRequest, dict]` The request object. Request message for `GetBillingAccount`.
`name`	`str` Required. The resource name of the billing account to retrieve. For example, `billingAccounts/012345-567890-ABCDEF`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.billing_v1.types.BillingAccount`	A billing account in [GCP Console](\ https://console.cloud.google.com/). You can assign a billing account to one or more projects.

get_iam_policy

get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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>__.

Parameters

Name	Description
`request`	`Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]` The request object. Request message for `GetIamPolicy` method.
`resource`	`str` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. This corresponds to the `resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

google.iam.v1.policy_pb2.Policy Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" bindings:="" -="" members:="" -="" user:\="" mike@example.com="" -="" group:\="" admins@example.com="" -="" domain:google.com="" -="" serviceaccount:\="" my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:\="" eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="" [iam="" developer's="" guide](\="">

get_project_billing_info

get_project_billing_info(request: Optional[Union[google.cloud.billing_v1.types.cloud_billing.GetProjectBillingInfoRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the billing information for a project. The current authenticated user must have permission to view the project <https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo>__.

Parameters

Name	Description
`request`	`Union[google.cloud.billing_v1.types.GetProjectBillingInfoRequest, dict]` The request object. Request message for `GetProjectBillingInfo`.
`name`	`str` Required. The resource name of the project for which billing information is retrieved. For example, `projects/tokyo-rain-123`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.billing_v1.types.ProjectBillingInfo`	Encapsulation of billing information for a GCP Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).

list_billing_accounts

list_billing_accounts(request: Optional[Union[google.cloud.billing_v1.types.cloud_billing.ListBillingAccountsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the billing accounts that the current authenticated user has permission to view <https://cloud.google.com/billing/docs/how-to/billing-access>__.

Parameters

Name	Description
`request`	`Union[google.cloud.billing_v1.types.ListBillingAccountsRequest, dict]` The request object. Request message for `ListBillingAccounts`.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.billing_v1.services.cloud_billing.pagers.ListBillingAccountsPager`	Response message for ListBillingAccounts. Iterating over this object will yield results and resolve additional pages automatically.

list_project_billing_info

list_project_billing_info(request: Optional[Union[google.cloud.billing_v1.types.cloud_billing.ListProjectBillingInfoRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists the projects associated with a billing account. The current authenticated user must have the billing.resourceAssociations.list IAM permission, which is often given to billing account viewers <https://cloud.google.com/billing/docs/how-to/billing-access>__.

Parameters

Name	Description
`request`	`Union[google.cloud.billing_v1.types.ListProjectBillingInfoRequest, dict]` The request object. Request message for `ListProjectBillingInfo`.
`name`	`str` Required. The resource name of the billing account associated with the projects that you want to list. For example, `billingAccounts/012345-567890-ABCDEF`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.billing_v1.services.cloud_billing.pagers.ListProjectBillingInfoPager`	Request message for ListProjectBillingInfoResponse. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

set_iam_policy

set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = None, *, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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>__.

Parameters

Name	Description
`request`	`Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]` The request object. Request message for `SetIamPolicy` method.
`resource`	`str` REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. This corresponds to the `resource` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type Description

test_iam_permissions

test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = None, *, resource: Optional[str] = None, permissions: Optional[Sequence[str]] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters

Name	Description
`request`	`Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]` The request object. Request message for `TestIamPermissions` method.
`resource`	`str` REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. This corresponds to the `resource` field on the `request` instance; if `request` is provided, this should not be set.
`permissions`	`Sequence[str]` The set of permissions to check for the `resource`. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see `IAM Overview https://cloud.google.com/iam/docs/overview#permissions`__. This corresponds to the `permissions` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse`	Response message for TestIamPermissions method.

update_billing_account

update_billing_account(request: Optional[Union[google.cloud.billing_v1.types.cloud_billing.UpdateBillingAccountRequest, dict]] = None, *, name: Optional[str] = None, account: Optional[google.cloud.billing_v1.types.cloud_billing.BillingAccount] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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.

Parameters

Name	Description
`request`	`Union[google.cloud.billing_v1.types.UpdateBillingAccountRequest, dict]` The request object. Request message for `UpdateBillingAccount`.
`name`	`str` Required. The name of the billing account resource to be updated. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`account`	`google.cloud.billing_v1.types.BillingAccount` Required. The billing account resource to replace the resource on the server. This corresponds to the `account` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.billing_v1.types.BillingAccount`	A billing account in [GCP Console](\ https://console.cloud.google.com/). You can assign a billing account to one or more projects.

update_project_billing_info

update_project_billing_info(request: Optional[Union[google.cloud.billing_v1.types.cloud_billing.UpdateProjectBillingInfoRequest, dict]] = None, *, name: Optional[str] = None, project_billing_info: Optional[google.cloud.billing_v1.types.cloud_billing.ProjectBillingInfo] = None, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets or updates the billing account associated with a project. You specify the new billing account by setting the billing_account_name in the ProjectBillingInfo resource to the resource name of a billing account. Associating a project with an open billing account enables billing on the project and allows charges for resource usage. If the project already had a billing account, this method changes the billing account used for resource usage charges.

Note: Incurred charges that have not yet been reported in the transaction history of the GCP Console might be billed to the new billing account, even if the charge occurred before the new billing account was assigned to the project.

The current authenticated user must have ownership privileges for both the project <https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo> and the billing account <https://cloud.google.com/billing/docs/how-to/billing-access>.

You can disable billing on the project by setting the billing_account_name field to empty. This action disassociates the current billing account from the project. Any billable activity of your in-use services will stop, and your application could stop functioning as expected. Any unbilled charges to date will be billed to the previously associated account. The current authenticated user must be either an owner of the project or an owner of the billing account for the project.

Note that associating a project with a closed billing account will have much the same effect as disabling billing on the project: any paid resources used by the project will be shut down. Thus, unless you wish to disable billing, you should always call this method with the name of an open billing account.

Parameters

Name	Description
`request`	`Union[google.cloud.billing_v1.types.UpdateProjectBillingInfoRequest, dict]` The request object. Request message for `UpdateProjectBillingInfo`.
`name`	`str` Required. The resource name of the project associated with the billing information that you want to update. For example, `projects/tokyo-rain-123`. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`project_billing_info`	`google.cloud.billing_v1.types.ProjectBillingInfo` The new billing information for the project. Read-only fields are ignored; thus, you can leave empty all fields except `billing_account_name`. This corresponds to the `project_billing_info` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.billing_v1.types.ProjectBillingInfo`	Encapsulation of billing information for a GCP Console project. A project has at most one associated billing account at a time (but a billing account can be assigned to multiple projects).