Class BillingClient

Index

Constructors

Methods

getCurrentMonthUsage getInvoicePdf getInvoicesSummary getOrgBillingInformation

Constructors

constructor

new BillingClient(transport: Transport): BillingClient
Parameters
- transport: Transport
Returns BillingClient

Methods

getCurrentMonthUsage

getCurrentMonthUsage(orgId: string): Promise<GetCurrentMonthUsageResponse>
Get the data usage information for the current month for a given organization.
Parameters
- orgId: string
  The organization ID.
Returns Promise<GetCurrentMonthUsageResponse>
Example
```
const usage = await billing.getCurrentMonthUsage('<organization-id>');
```

getInvoicePdf

getInvoicePdf(id: string, orgId: string): Promise<Uint8Array>
Get invoice PDF data.
Parameters
- id: string
  The invoice ID.
- orgId: string
  The organization ID.
Returns Promise<Uint8Array>
Example
```
const invoicePdf = await billing.getInvoicePdf(
  '<invoice-id>',
  '<organization-id>'
);
```

getInvoicesSummary

getInvoicesSummary(orgId: string): Promise<GetInvoicesSummaryResponse>
Get total outstanding balance plus invoice summaries for a given org.
Parameters
- orgId: string
  The organization ID.
Returns Promise<GetInvoicesSummaryResponse>
Example
```
const invoicesSummary = await billing.getInvoicesSummary(
  '<organization-id>'
);
```

getOrgBillingInformation

getOrgBillingInformation(
orgId: string,
): Promise<GetOrgBillingInformationResponse>
Get the billing information (payment method, billing tier, etc.) for a given org.
Parameters
- orgId: string
  The organization ID.
Returns Promise<GetOrgBillingInformationResponse>
Example
```
const billingInfo = await billing.getOrgBillingInformation(
  '<organization-id>'
);
```