Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

CloudBilling

import { CloudBilling } from "https://googleapis.deno.dev/v1/cloudbilling:v1.ts";

Allows developers to manage billing for their Google Cloud Platform projects programmatically.

class CloudBilling {
constructor(client?: CredentialsClient, baseUrl?: string);
async billingAccountsCreate(req: BillingAccount, opts?: BillingAccountsCreateOptions): Promise<BillingAccount>;
async billingAccountsGet(name: string): Promise<BillingAccount>;
async billingAccountsGetIamPolicy(resource: string, opts?: BillingAccountsGetIamPolicyOptions): Promise<Policy>;
async billingAccountsList(opts?: BillingAccountsListOptions): Promise<ListBillingAccountsResponse>;
async billingAccountsMove(name: string, req: MoveBillingAccountRequest): Promise<BillingAccount>;
async billingAccountsPatch(
name: string,
): Promise<BillingAccount>;
async billingAccountsProjectsList(name: string, opts?: BillingAccountsProjectsListOptions): Promise<ListProjectBillingInfoResponse>;
async billingAccountsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;
async billingAccountsSubAccountsCreate(parent: string, req: BillingAccount): Promise<BillingAccount>;
async billingAccountsSubAccountsList(parent: string, opts?: BillingAccountsSubAccountsListOptions): Promise<ListBillingAccountsResponse>;
async billingAccountsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;
async organizationsBillingAccountsCreate(parent: string, req: BillingAccount): Promise<BillingAccount>;
async organizationsBillingAccountsList(parent: string, opts?: OrganizationsBillingAccountsListOptions): Promise<ListBillingAccountsResponse>;
async organizationsBillingAccountsMove(destinationParent: string, name: string): Promise<BillingAccount>;
async projectsGetBillingInfo(name: string): Promise<ProjectBillingInfo>;
async projectsUpdateBillingInfo(name: string, req: ProjectBillingInfo): Promise<ProjectBillingInfo>;
async servicesList(opts?: ServicesListOptions): Promise<ListServicesResponse>;
async servicesSkusList(parent: string, opts?: ServicesSkusListOptions): Promise<ListSkusResponse>;
}

§Constructors

§
new CloudBilling(client?: CredentialsClient, baseUrl?: string)
[src]

§Methods

§
billingAccountsCreate(req: BillingAccount, opts?: BillingAccountsCreateOptions): Promise<BillingAccount>
[src]

This method creates billing subaccounts. Google Cloud resellers should use the Channel Services APIs, accounts.customers.create and accounts.customers.entitlements.create. When creating a subaccount, the current authenticated user must have the billing.accounts.update IAM permission on the parent account, which is typically given to billing account administrators. This method will return an error if the parent account has not been provisioned for subaccounts.

§
billingAccountsGet(name: string): Promise<BillingAccount>
[src]

Gets information about a billing account. The current authenticated user must be a viewer of the billing account.

@param name

Required. The resource name of the billing account to retrieve. For example, billingAccounts/012345-567890-ABCDEF.

§
billingAccountsGetIamPolicy(resource: string, opts?: BillingAccountsGetIamPolicyOptions): Promise<Policy>
[src]

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.

@param resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

§
billingAccountsList(opts?: BillingAccountsListOptions): Promise<ListBillingAccountsResponse>
[src]

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

§
billingAccountsMove(name: string, req: MoveBillingAccountRequest): Promise<BillingAccount>
[src]

Changes which parent organization a billing account belongs to.

@param name

Required. The resource name of the billing account to move. Must be of the form billingAccounts/{billing_account_id}. The specified billing account cannot be a subaccount, since a subaccount always belongs to the same organization as its parent account.

§
billingAccountsPatch(name: string, req: BillingAccount, opts?: BillingAccountsPatchOptions): Promise<BillingAccount>
[src]

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 of the billing account.

@param name

Required. The name of the billing account resource to be updated.

§
billingAccountsProjectsList(name: string, opts?: BillingAccountsProjectsListOptions): Promise<ListProjectBillingInfoResponse>
[src]

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.

@param name

Required. The resource name of the billing account associated with the projects that you want to list. For example, billingAccounts/012345-567890-ABCDEF.

§
billingAccountsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>
[src]

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.

@param resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

§
billingAccountsSubAccountsCreate(parent: string, req: BillingAccount): Promise<BillingAccount>
[src]

This method creates billing subaccounts. Google Cloud resellers should use the Channel Services APIs, accounts.customers.create and accounts.customers.entitlements.create. When creating a subaccount, the current authenticated user must have the billing.accounts.update IAM permission on the parent account, which is typically given to billing account administrators. This method will return an error if the parent account has not been provisioned for subaccounts.

@param parent

Optional. The parent to create a billing account from. Format: - billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF

§
billingAccountsSubAccountsList(parent: string, opts?: BillingAccountsSubAccountsListOptions): Promise<ListBillingAccountsResponse>
[src]

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

@param parent

Optional. The parent resource to list billing accounts from. Format: - organizations/{organization_id}, for example, organizations/12345678 - billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF

§
billingAccountsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>
[src]

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.

@param resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

§
organizationsBillingAccountsCreate(parent: string, req: BillingAccount): Promise<BillingAccount>
[src]

This method creates billing subaccounts. Google Cloud resellers should use the Channel Services APIs, accounts.customers.create and accounts.customers.entitlements.create. When creating a subaccount, the current authenticated user must have the billing.accounts.update IAM permission on the parent account, which is typically given to billing account administrators. This method will return an error if the parent account has not been provisioned for subaccounts.

@param parent

Optional. The parent to create a billing account from. Format: - billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF

§
organizationsBillingAccountsList(parent: string, opts?: OrganizationsBillingAccountsListOptions): Promise<ListBillingAccountsResponse>
[src]

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

@param parent

Optional. The parent resource to list billing accounts from. Format: - organizations/{organization_id}, for example, organizations/12345678 - billingAccounts/{billing_account_id}, for example, billingAccounts/012345-567890-ABCDEF

§
organizationsBillingAccountsMove(destinationParent: string, name: string): Promise<BillingAccount>
[src]

Changes which parent organization a billing account belongs to.

@param destinationParent

Required. The resource name of the Organization to move the billing account under. Must be of the form organizations/{organization_id}.

@param name

Required. The resource name of the billing account to move. Must be of the form billingAccounts/{billing_account_id}. The specified billing account cannot be a subaccount, since a subaccount always belongs to the same organization as its parent account.

§
projectsGetBillingInfo(name: string): Promise<ProjectBillingInfo>
[src]

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

@param name

Required. The resource name of the project for which billing information is retrieved. For example, projects/tokyo-rain-123.

§
projectsUpdateBillingInfo(name: string, req: ProjectBillingInfo): Promise<ProjectBillingInfo>
[src]

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 and the billing account. 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.

@param name

Required. The resource name of the project associated with the billing information that you want to update. For example, projects/tokyo-rain-123.

§
servicesList(opts?: ServicesListOptions): Promise<ListServicesResponse>
[src]

Lists all public cloud services.

§
servicesSkusList(parent: string, opts?: ServicesSkusListOptions): Promise<ListSkusResponse>
[src]

Lists all publicly available SKUs for a given cloud service.

@param parent

Required. The name of the service. Example: "services/DA34-426B-A397"