SDK: billing

The billing area has 16 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).

billingCancel

Cancel the subscription (a person does this: payments are human only)

• Request: POST on /v1/tenants/{tenantId}/billing/cancel

billingCancel(args: { tenantId: string; body: CancelRequest }, options?: CallOptions): Promise<Subscription>

billingCapsDelete

Remove a spending cap

• Request: DELETE on /v1/tenants/{tenantId}/billing/caps

billingCapsDelete(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>

billingCapsGet

Spending caps

• Request: GET on /v1/tenants/{tenantId}/billing/caps

billingCapsGet(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>

billingCapsPut

Set a spending cap (spend class)

• Request: PUT on /v1/tenants/{tenantId}/billing/caps

billingCapsPut(args: { tenantId: string; body: PutCapRequest }, options?: CallOptions): Promise<Cap>

billingCheckout

Start a checkout (a person does this: payments are human only)

• Request: POST on /v1/tenants/{tenantId}/billing/checkout

billingCheckout(args: { tenantId: string; body: CheckoutRequest }, options?: CallOptions): Promise<CheckoutResponse>

billingInvoices

Invoices

• Request: GET on /v1/tenants/{tenantId}/billing/invoices

billingInvoices(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>

billingLimits

Plan limits and what is left

• Request: GET on /v1/tenants/{tenantId}/billing/limits

billingLimits(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>

billingPlan

Change plan (a person does this: payments are human only)

• Request: POST on /v1/tenants/{tenantId}/billing/plan

billingPlan(args: { tenantId: string; body: ChangePlanRequest }, options?: CallOptions): Promise<ChangePlanResponse>

billingPool

What is left of the pooled allowance and each member’s fair share of it

• Request: GET on /v1/tenants/{tenantId}/billing/pool

billingPool(args: { tenantId: string }, options?: CallOptions): Promise<PoolShares>

billingPortal

Open the billing portal (a person does this: payments are human only)

• Request: POST on /v1/tenants/{tenantId}/billing/portal

billingPortal(args: { tenantId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<PortalResponse>

billingProjectUsage

What one project used this period, per meter, for a token limited to that project

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/billing/usage

billingProjectUsage(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<ProjectUsage>

billingSeats

Change seats (a person does this: payments are human only)

• Request: POST on /v1/tenants/{tenantId}/billing/seats

billingSeats(args: { tenantId: string; body: SeatChangeRequest }, options?: CallOptions): Promise<SeatChangeResponse>

billingStatus

Plan, seats and billing state

• Request: GET on /v1/tenants/{tenantId}/billing

billingStatus(args: { tenantId: string }, options?: CallOptions): Promise<BillingStatus>

billingUsageDecision

Whether metered use may go ahead

• Request: POST on /v1/tenants/{tenantId}/billing/usage/decision

billingUsageDecision(args: { tenantId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<UsageDecision>

billingUsageGet

Metered usage

• Request: GET on /v1/tenants/{tenantId}/billing/usage

billingUsageGet(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>

billingUsageRecord

Record metered usage

• Request: POST on /v1/tenants/{tenantId}/billing/usage

billingUsageRecord(args: { tenantId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>