Package billing is an auto-generated package for the Cloud Billing API.
Allows developers to manage billing for their Google Cloud Platform projects programmatically.
General documentation
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview. Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
// go get cloud.google.com/go/billing/apiv1@latest ctx := context.Background() // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c, err := billing.NewCloudBillingClient(ctx) if err != nil { // TODO: Handle error. } defer c.Close()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client, mentioned above.
req := &billingpb.CreateBillingAccountRequest{ // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/billing/apiv1/billingpb#CreateBillingAccountRequest. } resp, err := c.CreateBillingAccount(ctx, req) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewCloudBillingClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
Functions
func DefaultAuthScopes
func DefaultAuthScopes() []string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
BillingAccountIterator
type BillingAccountIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int, pageToken string) (results []*billingpb.BillingAccount, nextPageToken string, err error)
// contains filtered or unexported fields
}
BillingAccountIterator manages a stream of *billingpb.BillingAccount.
func (*BillingAccountIterator) All
func (it *BillingAccountIterator) All() iter.Seq2[*billingpb.BillingAccount, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*BillingAccountIterator) Next
func (it *BillingAccountIterator) Next() (*billingpb.BillingAccount, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*BillingAccountIterator) PageInfo
func (it *BillingAccountIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
CloudBillingCallOptions
type CloudBillingCallOptions struct {
GetBillingAccount []gax.CallOption
ListBillingAccounts []gax.CallOption
UpdateBillingAccount []gax.CallOption
CreateBillingAccount []gax.CallOption
ListProjectBillingInfo []gax.CallOption
GetProjectBillingInfo []gax.CallOption
UpdateProjectBillingInfo []gax.CallOption
GetIamPolicy []gax.CallOption
SetIamPolicy []gax.CallOption
TestIamPermissions []gax.CallOption
MoveBillingAccount []gax.CallOption
}
CloudBillingCallOptions contains the retry settings for each method of CloudBillingClient.
CloudBillingClient
type CloudBillingClient struct {
// The call options for this service.
CallOptions *CloudBillingCallOptions
// contains filtered or unexported fields
}
CloudBillingClient is a client for interacting with Cloud Billing API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
Retrieves the Google Cloud Console billing accounts and associates them with projects.
func NewCloudBillingClient
func NewCloudBillingClient(ctx context.Context, opts ...option.ClientOption) (*CloudBillingClient, error)
NewCloudBillingClient creates a new cloud billing client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
Retrieves the Google Cloud Console billing accounts and associates them with projects.
Example
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudBillingClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func NewCloudBillingRESTClient
func NewCloudBillingRESTClient(ctx context.Context, opts ...option.ClientOption) (*CloudBillingClient, error)
NewCloudBillingRESTClient creates a new cloud billing rest client.
Retrieves the Google Cloud Console billing accounts and associates them with projects.
Example
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudBillingRESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*CloudBillingClient) Close
func (c *CloudBillingClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*CloudBillingClient) Connection (deprecated)
func (c *CloudBillingClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*CloudBillingClient) CreateBillingAccount
func (c *CloudBillingClient) CreateBillingAccount(ctx context.Context, req *billingpb.CreateBillingAccountRequest, opts ...gax.CallOption) (*billingpb.BillingAccount, error)
CreateBillingAccount this method creates billing subaccounts (at https://cloud.google.com/billing/docs/concepts#subaccounts).
Google Cloud resellers should use the Channel Services APIs, accounts.customers.create (at https://cloud.google.com/channel/docs/reference/rest/v1/accounts.customers/create) and accounts.customers.entitlements.create (at https://cloud.google.com/channel/docs/reference/rest/v1/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 (at https://cloud.google.com/billing/docs/how-to/billing-access). This method will return an error if the parent account has not been provisioned for subaccounts.
Example
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
billingpb "cloud.google.com/go/billing/apiv1/billingpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudBillingClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &billingpb.CreateBillingAccountRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/apiv1/billingpb#CreateBillingAccountRequest.
}
resp, err := c.CreateBillingAccount(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*CloudBillingClient) GetBillingAccount
func (c *CloudBillingClient) GetBillingAccount(ctx context.Context, req *billingpb.GetBillingAccountRequest, opts ...gax.CallOption) (*billingpb.BillingAccount, error)
GetBillingAccount gets information about a billing account. The current authenticated user must be a viewer of the billing account (at https://cloud.google.com/billing/docs/how-to/billing-access).
Example
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
billingpb "cloud.google.com/go/billing/apiv1/billingpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudBillingClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &billingpb.GetBillingAccountRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/apiv1/billingpb#GetBillingAccountRequest.
}
resp, err := c.GetBillingAccount(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*CloudBillingClient) GetIamPolicy
func (c *CloudBillingClient) GetIamPolicy(ctx context.Context, req *iampb.GetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
GetIamPolicy 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 (at https://cloud.google.com/billing/docs/how-to/billing-access).
Example
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
iampb "cloud.google.com/go/iam/apiv1/iampb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudBillingClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &iampb.GetIamPolicyRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#GetIamPolicyRequest.
}
resp, err := c.GetIamPolicy(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*CloudBillingClient) GetProjectBillingInfo
func (c *CloudBillingClient) GetProjectBillingInfo(ctx context.Context, req *billingpb.GetProjectBillingInfoRequest, opts ...gax.CallOption) (*billingpb.ProjectBillingInfo, error)
GetProjectBillingInfo gets the billing information for a project. The current authenticated user must have the resourcemanager.projects.get permission for the project, which can be granted by assigning the Project Viewer (at https://cloud.google.com/iam/docs/understanding-roles#predefined_roles) role.
Example
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
billingpb "cloud.google.com/go/billing/apiv1/billingpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudBillingClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &billingpb.GetProjectBillingInfoRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/apiv1/billingpb#GetProjectBillingInfoRequest.
}
resp, err := c.GetProjectBillingInfo(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*CloudBillingClient) ListBillingAccounts
func (c *CloudBillingClient) ListBillingAccounts(ctx context.Context, req *billingpb.ListBillingAccountsRequest, opts ...gax.CallOption) *BillingAccountIterator
ListBillingAccounts lists the billing accounts that the current authenticated user has permission to view (at https://cloud.google.com/billing/docs/how-to/billing-access).
Examples
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
billingpb "cloud.google.com/go/billing/apiv1/billingpb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudBillingClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &billingpb.ListBillingAccountsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/apiv1/billingpb#ListBillingAccountsRequest.
}
it := c.ListBillingAccounts(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*billingpb.ListBillingAccountsResponse)
}
}
all
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
billingpb "cloud.google.com/go/billing/apiv1/billingpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudBillingClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &billingpb.ListBillingAccountsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/apiv1/billingpb#ListBillingAccountsRequest.
}
for resp, err := range c.ListBillingAccounts(ctx, req).All() {
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*CloudBillingClient) ListProjectBillingInfo
func (c *CloudBillingClient) ListProjectBillingInfo(ctx context.Context, req *billingpb.ListProjectBillingInfoRequest, opts ...gax.CallOption) *ProjectBillingInfoIterator
ListProjectBillingInfo 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 (at https://cloud.google.com/billing/docs/how-to/billing-access).
Examples
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
billingpb "cloud.google.com/go/billing/apiv1/billingpb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudBillingClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &billingpb.ListProjectBillingInfoRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/apiv1/billingpb#ListProjectBillingInfoRequest.
}
it := c.ListProjectBillingInfo(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*billingpb.ListProjectBillingInfoResponse)
}
}
all
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
billingpb "cloud.google.com/go/billing/apiv1/billingpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudBillingClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &billingpb.ListProjectBillingInfoRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/apiv1/billingpb#ListProjectBillingInfoRequest.
}
for resp, err := range c.ListProjectBillingInfo(ctx, req).All() {
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*CloudBillingClient) MoveBillingAccount
func (c *CloudBillingClient) MoveBillingAccount(ctx context.Context, req *billingpb.MoveBillingAccountRequest, opts ...gax.CallOption) (*billingpb.BillingAccount, error)
MoveBillingAccount changes which parent organization a billing account belongs to.
Example
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
billingpb "cloud.google.com/go/billing/apiv1/billingpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudBillingClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &billingpb.MoveBillingAccountRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/apiv1/billingpb#MoveBillingAccountRequest.
}
resp, err := c.MoveBillingAccount(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*CloudBillingClient) SetIamPolicy
func (c *CloudBillingClient) SetIamPolicy(ctx context.Context, req *iampb.SetIamPolicyRequest, opts ...gax.CallOption) (*iampb.Policy, error)
SetIamPolicy 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 (at https://cloud.google.com/billing/docs/how-to/billing-access).
Example
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
iampb "cloud.google.com/go/iam/apiv1/iampb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudBillingClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &iampb.SetIamPolicyRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#SetIamPolicyRequest.
}
resp, err := c.SetIamPolicy(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*CloudBillingClient) TestIamPermissions
func (c *CloudBillingClient) TestIamPermissions(ctx context.Context, req *iampb.TestIamPermissionsRequest, opts ...gax.CallOption) (*iampb.TestIamPermissionsResponse, error)
TestIamPermissions 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.
Example
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
iampb "cloud.google.com/go/iam/apiv1/iampb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudBillingClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &iampb.TestIamPermissionsRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#TestIamPermissionsRequest.
}
resp, err := c.TestIamPermissions(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*CloudBillingClient) UpdateBillingAccount
func (c *CloudBillingClient) UpdateBillingAccount(ctx context.Context, req *billingpb.UpdateBillingAccountRequest, opts ...gax.CallOption) (*billingpb.BillingAccount, error)
UpdateBillingAccount 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 (at https://cloud.google.com/billing/docs/how-to/billing-access) of the billing account.
Example
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
billingpb "cloud.google.com/go/billing/apiv1/billingpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudBillingClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &billingpb.UpdateBillingAccountRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/apiv1/billingpb#UpdateBillingAccountRequest.
}
resp, err := c.UpdateBillingAccount(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
func (*CloudBillingClient) UpdateProjectBillingInfo
func (c *CloudBillingClient) UpdateProjectBillingInfo(ctx context.Context, req *billingpb.UpdateProjectBillingInfoRequest, opts ...gax.CallOption) (*billingpb.ProjectBillingInfo, error)
UpdateProjectBillingInfo 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 Google Cloud 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 (at https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo) and the billing account (at 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.
Example
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
billingpb "cloud.google.com/go/billing/apiv1/billingpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudBillingClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &billingpb.UpdateProjectBillingInfoRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/apiv1/billingpb#UpdateProjectBillingInfoRequest.
}
resp, err := c.UpdateProjectBillingInfo(ctx, req)
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
CloudCatalogCallOptions
type CloudCatalogCallOptions struct {
ListServices []gax.CallOption
ListSkus []gax.CallOption
}
CloudCatalogCallOptions contains the retry settings for each method of CloudCatalogClient.
CloudCatalogClient
type CloudCatalogClient struct {
// The call options for this service.
CallOptions *CloudCatalogCallOptions
// contains filtered or unexported fields
}
CloudCatalogClient is a client for interacting with Cloud Billing API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
A catalog of Google Cloud Platform services and SKUs. Provides pricing information and metadata on Google Cloud Platform services and SKUs.
func NewCloudCatalogClient
func NewCloudCatalogClient(ctx context.Context, opts ...option.ClientOption) (*CloudCatalogClient, error)
NewCloudCatalogClient creates a new cloud catalog client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
A catalog of Google Cloud Platform services and SKUs. Provides pricing information and metadata on Google Cloud Platform services and SKUs.
Example
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudCatalogClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func NewCloudCatalogRESTClient
func NewCloudCatalogRESTClient(ctx context.Context, opts ...option.ClientOption) (*CloudCatalogClient, error)
NewCloudCatalogRESTClient creates a new cloud catalog rest client.
A catalog of Google Cloud Platform services and SKUs. Provides pricing information and metadata on Google Cloud Platform services and SKUs.
Example
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudCatalogRESTClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
// TODO: Use client.
_ = c
}
func (*CloudCatalogClient) Close
func (c *CloudCatalogClient) Close() error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*CloudCatalogClient) Connection (deprecated)
func (c *CloudCatalogClient) Connection() *grpc.ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*CloudCatalogClient) ListServices
func (c *CloudCatalogClient) ListServices(ctx context.Context, req *billingpb.ListServicesRequest, opts ...gax.CallOption) *ServiceIterator
ListServices lists all public cloud services.
Examples
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
billingpb "cloud.google.com/go/billing/apiv1/billingpb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudCatalogClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &billingpb.ListServicesRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/apiv1/billingpb#ListServicesRequest.
}
it := c.ListServices(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*billingpb.ListServicesResponse)
}
}
all
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
billingpb "cloud.google.com/go/billing/apiv1/billingpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudCatalogClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &billingpb.ListServicesRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/apiv1/billingpb#ListServicesRequest.
}
for resp, err := range c.ListServices(ctx, req).All() {
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
func (*CloudCatalogClient) ListSkus
func (c *CloudCatalogClient) ListSkus(ctx context.Context, req *billingpb.ListSkusRequest, opts ...gax.CallOption) *SkuIterator
ListSkus lists all publicly available SKUs for a given cloud service.
Examples
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
billingpb "cloud.google.com/go/billing/apiv1/billingpb"
"google.golang.org/api/iterator"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudCatalogClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &billingpb.ListSkusRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/apiv1/billingpb#ListSkusRequest.
}
it := c.ListSkus(ctx, req)
for {
resp, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_ = it.Response.(*billingpb.ListSkusResponse)
}
}
all
package main
import (
"context"
billing "cloud.google.com/go/billing/apiv1"
billingpb "cloud.google.com/go/billing/apiv1/billingpb"
)
func main() {
ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := billing.NewCloudCatalogClient(ctx)
if err != nil {
// TODO: Handle error.
}
defer c.Close()
req := &billingpb.ListSkusRequest{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/billing/apiv1/billingpb#ListSkusRequest.
}
for resp, err := range c.ListSkus(ctx, req).All() {
if err != nil {
// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
}
}
ProjectBillingInfoIterator
type ProjectBillingInfoIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int, pageToken string) (results []*billingpb.ProjectBillingInfo, nextPageToken string, err error)
// contains filtered or unexported fields
}
ProjectBillingInfoIterator manages a stream of *billingpb.ProjectBillingInfo.
func (*ProjectBillingInfoIterator) All
func (it *ProjectBillingInfoIterator) All() iter.Seq2[*billingpb.ProjectBillingInfo, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ProjectBillingInfoIterator) Next
func (it *ProjectBillingInfoIterator) Next() (*billingpb.ProjectBillingInfo, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ProjectBillingInfoIterator) PageInfo
func (it *ProjectBillingInfoIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
ServiceIterator
type ServiceIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int, pageToken string) (results []*billingpb.Service, nextPageToken string, err error)
// contains filtered or unexported fields
}
ServiceIterator manages a stream of *billingpb.Service.
func (*ServiceIterator) All
func (it *ServiceIterator) All() iter.Seq2[*billingpb.Service, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ServiceIterator) Next
func (it *ServiceIterator) Next() (*billingpb.Service, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*ServiceIterator) PageInfo
func (it *ServiceIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
SkuIterator
type SkuIterator struct {
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response interface{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch func(pageSize int, pageToken string) (results []*billingpb.Sku, nextPageToken string, err error)
// contains filtered or unexported fields
}
SkuIterator manages a stream of *billingpb.Sku.
func (*SkuIterator) All
func (it *SkuIterator) All() iter.Seq2[*billingpb.Sku, error]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*SkuIterator) Next
func (it *SkuIterator) Next() (*billingpb.Sku, error)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*SkuIterator) PageInfo
func (it *SkuIterator) PageInfo() *iterator.PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.