Class BillingClient

Billing organizations: create/get, child-org linking, and resource limits/usage.

Index

Constructors

Methods

create get getResourceUsage linkOrganization listChildren unlinkOrganization updateResourceLimits

Constructors

constructor

new BillingClient(call: Caller): BillingClient
Parameters
- call: Caller
Returns BillingClient
- Defined in src/resources/billing.ts:60

Methods

create

create(
req: CreateBillingOrganizationRequest,
opts?: RequestOptions,
): Promise<OrganizationData>
Create a billing organization.
Parameters
- req: CreateBillingOrganizationRequest
- Optionalopts: RequestOptions
Returns Promise<OrganizationData>
Throws
ValidationError if the request body is rejected.
- Defined in src/resources/billing.ts:66

get

get(
billingOrganizationId: string,
opts?: RequestOptions,
): Promise<OrganizationData>
Fetch a billing organization by id.
Parameters
- billingOrganizationId: string
- Optionalopts: RequestOptions
Returns Promise<OrganizationData>
Throws
NotFoundError if the billing organization does not exist.
- Defined in src/resources/billing.ts:78

getResourceUsage

getResourceUsage(
params: { billingOrganizationId: string },
opts?: RequestOptions,
): Promise<BillingResourceUsage>
Current resource usage rollup plus the configured limits.
Parameters
- params: { billingOrganizationId: string }
- Optionalopts: RequestOptions
Returns Promise<BillingResourceUsage>
- Defined in src/resources/billing.ts:134

linkOrganization

linkOrganization(
req: LinkOrganizationRequest,
opts?: RequestOptions,
): Promise<void>
Link an existing organization as a child of a billing organization.
Parameters
- req: LinkOrganizationRequest
- Optionalopts: RequestOptions
Returns Promise<void>
- Defined in src/resources/billing.ts:98

listChildren

listChildren(
params: { billingOrganizationId: string },
opts?: RequestOptions,
): Promise<OrganizationData[]>
List the child organizations linked under a billing organization.
Parameters
- params: { billingOrganizationId: string }
- Optionalopts: RequestOptions
Returns Promise<OrganizationData[]>
- Defined in src/resources/billing.ts:86

unlinkOrganization

unlinkOrganization(
req: UnlinkOrganizationRequest,
opts?: RequestOptions,
): Promise<void>
Unlink a child organization from a billing organization.
Parameters
- req: UnlinkOrganizationRequest
- Optionalopts: RequestOptions
Returns Promise<void>
- Defined in src/resources/billing.ts:110

updateResourceLimits

updateResourceLimits(
req: UpdateResourceLimitsRequest,
opts?: RequestOptions,
): Promise<void>
Update resource limits on a billing organization (partial update).
Parameters
- req: UpdateResourceLimitsRequest
- Optionalopts: RequestOptions
Returns Promise<void>
- Defined in src/resources/billing.ts:121