Class CloudBillingClient (1.0.0)

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: <module 'google.api_core.client_options' from '/workspace/python-billing/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = ClientOptions: {'api_endpoint': 'cloudbilling.googleapis.com', 'client_cert_source': None, 'client_encrypted_cert_source': None, 'quota_project_id': None, 'credentials_file': None, 'scopes': None, 'api_key': None, 'api_audience': None})

Retrieves GCP Console billing accounts and associates them with projects.

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: <module 'google.api_core.client_options' from '/workspace/python-billing/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = ClientOptions: {'api_endpoint': 'cloudbilling.googleapis.com', 'client_cert_source': None, 'client_encrypted_cert_source': None, 'quota_project_id': None, 'credentials_file': None, 'scopes': None, 'api_key': None, 'api_audience': None})

Instantiate 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`	`ClientOptions` Custom options for the client.

create_billing_account

create_billing_account(request: Optional[google.cloud.billing_v1.types.cloud_billing.CreateBillingAccountRequest] = None, *, billing_account: Optional[google.cloud.billing_v1.types.cloud_billing.BillingAccount] = None, retry: google.api_core.retry.Retry = <_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`	`.cloud_billing.CreateBillingAccountRequest` The request object. Request message for `CreateBillingAccount`.
`billing_account`	`.cloud_billing.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
`.cloud_billing.BillingAccount`	A billing account in `GCP Console` __. 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
`{@api.name}`	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
`{@api.name}`	The constructed client.

get_billing_account

get_billing_account(request: Optional[google.cloud.billing_v1.types.cloud_billing.GetBillingAccountRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_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`	`.cloud_billing.GetBillingAccountRequest` 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
`.cloud_billing.BillingAccount`	A billing account in `GCP Console` __. You can assign a billing account to one or more projects.

get_iam_policy

get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, resource: Optional[str] = None, retry: google.api_core.retry.Retry = <_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`	`.iam_policy.GetIamPolicyRequest` The request object. Request message for `GetIamPolicy` method.
`resource`	`str` REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. 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

.policy.Policy Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy consists of a list of bindings. A Binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM. **Example** :: { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com", ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the IAM developer's guide __.

get_project_billing_info

get_project_billing_info(request: Optional[google.cloud.billing_v1.types.cloud_billing.GetProjectBillingInfoRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_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`	`.cloud_billing.GetProjectBillingInfoRequest` 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
`.cloud_billing.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[google.cloud.billing_v1.types.cloud_billing.ListBillingAccountsRequest] = None, *, retry: google.api_core.retry.Retry = <_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`	`.cloud_billing.ListBillingAccountsRequest` 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
`.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[google.cloud.billing_v1.types.cloud_billing.ListProjectBillingInfoRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_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`	`.cloud_billing.ListProjectBillingInfoRequest` 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
`.pagers.ListProjectBillingInfoPager`	Request message for `ListProjectBillingInfoResponse`. Iterating over this object will yield results and resolve additional pages automatically.

set_iam_policy

set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, resource: Optional[str] = None, retry: google.api_core.retry.Retry = <_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`	`.iam_policy.SetIamPolicyRequest` The request object. Request message for `SetIamPolicy` method.
`resource`	`str` REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. 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[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, resource: Optional[str] = None, permissions: Optional[Sequence[str]] = None, retry: google.api_core.retry.Retry = <_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`	`.iam_policy.TestIamPermissionsRequest` The request object. Request message for `TestIamPermissions` method.
`resource`	`str` REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path. For example, a Project resource is specified as `projects/{project}`. This corresponds to the `resource` field on the `request` instance; if `request` is provided, this should not be set.
`permissions`	`:class: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
`.iam_policy.TestIamPermissionsResponse`	Response message for `TestIamPermissions` method.

update_billing_account

update_billing_account(request: Optional[google.cloud.billing_v1.types.cloud_billing.UpdateBillingAccountRequest] = None, *, name: Optional[str] = None, account: Optional[google.cloud.billing_v1.types.cloud_billing.BillingAccount] = None, retry: google.api_core.retry.Retry = <_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`	`.cloud_billing.UpdateBillingAccountRequest` 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`	`.cloud_billing.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
`.cloud_billing.BillingAccount`	A billing account in `GCP Console` __. You can assign a billing account to one or more projects.

update_project_billing_info

update_project_billing_info(request: Optional[google.cloud.billing_v1.types.cloud_billing.UpdateProjectBillingInfoRequest] = None, *, name: Optional[str] = None, project_billing_info: Optional[google.cloud.billing_v1.types.cloud_billing.ProjectBillingInfo] = None, retry: google.api_core.retry.Retry = <_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`	`.cloud_billing.UpdateProjectBillingInfoRequest` 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`	`.cloud_billing.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
`.cloud_billing.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).