Billing API, gRPC: BillingAccountService

A set of methods for managing BillingAccount resources.

Call	Description
Get	Returns the specified billing account.
List	Retrieves the list of billing accounts available for current user.
ListBillableObjectBindings	Retrieves the list of billable object bindings associated with the specified billing account.
BindBillableObject	Binds billable object to the specified billing account.
ListAccessBindings	Lists access bindings for the specified billing account.
UpdateAccessBindings	Updates access bindings for the specified billing account.

Calls BillingAccountServiceCalls BillingAccountService

GetGet

Returns the specified billing account.

rpc Get (GetBillingAccountRequest) returns (BillingAccount)

GetBillingAccountRequestGetBillingAccountRequest

Field	Description
id	string Required. ID of the billing account to return. To get the billing account ID, use BillingAccountService.List request. The maximum string length in characters is 50.

BillingAccountBillingAccount

Field	Description
id	string ID of the billing account.
name	string Name of the billing account.
created_at	google.protobuf.Timestamp Creation timestamp.
country_code	string ISO 3166-1 alpha-2 country code of the billing account.
currency	string Currency of the billing account. Can be one of the following: RUB USD KZT
active	bool Represents whether corresponding billable objects can be used or not.
balance	string Current balance of the billing account.

ListList

Retrieves the list of billing accounts available for current user.

rpc List (ListBillingAccountsRequest) returns (ListBillingAccountsResponse)

ListBillingAccountsRequestListBillingAccountsRequest

Field	Description
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListBillingAccountsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListBillingAccountsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListBillingAccountsResponseListBillingAccountsResponse

Field	Description
billing_accounts[]	BillingAccount List of billing accounts.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListBillingAccountsRequest.page_size, use next_page_token as the value for the ListBillingAccountsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

BillingAccountBillingAccount

Field	Description
id	string ID of the billing account.
name	string Name of the billing account.
created_at	google.protobuf.Timestamp Creation timestamp.
country_code	string ISO 3166-1 alpha-2 country code of the billing account.
currency	string Currency of the billing account. Can be one of the following: RUB USD KZT
active	bool Represents whether corresponding billable objects can be used or not.
balance	string Current balance of the billing account.

ListBillableObjectBindingsListBillableObjectBindings

Retrieves the list of billable object bindings associated with the specified billing account.

rpc ListBillableObjectBindings (ListBillableObjectBindingsRequest) returns (ListBillableObjectBindingsResponse)

ListBillableObjectBindingsRequestListBillableObjectBindingsRequest

Field	Description
billing_account_id	string Required. ID of the billing account to list associated billable object bindings. To get the billing account ID, use BillingAccountService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListBillableObjectBindingsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListBillableObjectBindingsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListBillableObjectBindingsResponseListBillableObjectBindingsResponse

Field	Description
billable_object_bindings[]	BillableObjectBinding List of billable object bindings.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListBillableObjectBindingsRequest.page_size, use next_page_token as the value for the ListBillableObjectBindingsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

BillableObjectBindingBillableObjectBinding

Field	Description
effective_time	google.protobuf.Timestamp Timestamp when binding was created.
billable_object	BillableObject Object that is bound to billing account.

BillableObjectBillableObject

Field	Description
id	string ID of the object in other service.
type	string Billable object type. Can be one of the following: cloud

BindBillableObjectBindBillableObject

Binds billable object to the specified billing account.

rpc BindBillableObject (BindBillableObjectRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:BindBillableObjectMetadata

    Operation.response:BillableObjectBinding

BindBillableObjectRequestBindBillableObjectRequest

Field	Description
billing_account_id	string Required. ID of the billing account to bind billable object. To get the billing account ID, use BillingAccountService.List request. The maximum string length in characters is 50.
billable_object	BillableObject billing.v1.BillableObject to bind with billing account.

BillableObjectBillableObject

Field	Description
id	string ID of the object in other service.
type	string Billable object type. Can be one of the following: cloud

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<BindBillableObjectMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<BillableObjectBinding> if operation finished successfully.

BindBillableObjectMetadataBindBillableObjectMetadata

Field	Description
billable_object_id	string ID of the billing.v1.BillableObject that was bound to billing account.

BillableObjectBindingBillableObjectBinding

Field	Description
effective_time	google.protobuf.Timestamp Timestamp when binding was created.
billable_object	BillableObject Object that is bound to billing account.

ListAccessBindingsListAccessBindings

Lists access bindings for the specified billing account.

rpc ListAccessBindings (ListAccessBindingsRequest) returns (ListAccessBindingsResponse)

ListAccessBindingsRequestListAccessBindingsRequest

Field	Description
resource_id	string Required. ID of the resource to list access bindings for. To get the resource ID, use a corresponding List request. For example, use the resourcemanager.v1.CloudService.List request to get the Cloud resource ID. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page that should be returned. If the number of available results is larger than page_size, the service returns a ListAccessBindingsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000.
page_token	string Page token. Set page_token to the ListAccessBindingsResponse.next_page_token returned by a previous list request to get the next page of results. The maximum string length in characters is 100.

ListAccessBindingsResponseListAccessBindingsResponse

Field	Description
access_bindings[]	AccessBinding List of access bindings for the specified resource.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListAccessBindingsRequest.page_size, use the next_page_token as the value for the ListAccessBindingsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

AccessBindingAccessBinding

Field	Description
role_id	string Required. ID of the iam.v1.Role that is assigned to the subject. The maximum string length in characters is 50.
subject	Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier.

SubjectSubject

Field	Description
id	string Required. ID of the subject. It can contain one of the following values: allAuthenticatedUsers: A special system identifier that represents anyone who is authenticated. It can be used only if the type is system. allUsers: A special system identifier that represents anyone. No authentication is required. For example, you don't need to specify the IAM token in an API query. <cloud generated id>: An identifier that represents a user account. It can be used only if the type is federatedUser or serviceAccount. The maximum string length in characters is 50.
type	string Required. Type of the subject. It can contain one of the following values: serviceAccount: A service account. This type represents the iam.v1.ServiceAccount resource. federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory. system: System group. This type represents several accounts with a common system identifier. For more information, see Subject to which the role is assigned. The maximum string length in characters is 100.

UpdateAccessBindingsUpdateAccessBindings

Updates access bindings for the specified billing account.

rpc UpdateAccessBindings (UpdateAccessBindingsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateAccessBindingsMetadata

    Operation.response:google.protobuf.Empty

UpdateAccessBindingsRequestUpdateAccessBindingsRequest

Field	Description
resource_id	string Required. ID of the resource for which access bindings are being updated. The maximum string length in characters is 50.
access_binding_deltas[]	AccessBindingDelta Required. Updates to access bindings. The number of elements must be greater than 0.

AccessBindingDeltaAccessBindingDelta

Field	Description
action	enum AccessBindingAction Required. The action that is being performed on an access binding. ADD: Addition of an access binding. REMOVE: Removal of an access binding.
access_binding	AccessBinding Required. Access binding. For more information, see Access Bindings.

AccessBindingAccessBinding

Field	Description
role_id	string Required. ID of the iam.v1.Role that is assigned to the subject. The maximum string length in characters is 50.
subject	Subject Required. Identity for which access binding is being created. It can represent an account with a unique ID or several accounts with a system identifier.

SubjectSubject

Field	Description
id	string Required. ID of the subject. It can contain one of the following values: allAuthenticatedUsers: A special system identifier that represents anyone who is authenticated. It can be used only if the type is system. allUsers: A special system identifier that represents anyone. No authentication is required. For example, you don't need to specify the IAM token in an API query. <cloud generated id>: An identifier that represents a user account. It can be used only if the type is federatedUser or serviceAccount. The maximum string length in characters is 50.
type	string Required. Type of the subject. It can contain one of the following values: serviceAccount: A service account. This type represents the iam.v1.ServiceAccount resource. federatedUser: A federated account. This type represents a user from an identity federation, like Active Directory. system: System group. This type represents several accounts with a common system identifier. For more information, see Subject to which the role is assigned. The maximum string length in characters is 100.

OperationOperation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<UpdateAccessBindingsMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

UpdateAccessBindingsMetadataUpdateAccessBindingsMetadata

Field	Description
resource_id	string ID of the resource for which access bindings are being updated.