Class API

Billing API.

This API allows you to manage and query your Scaleway billing and consumption.

Hierarchy

API
- API

Index

Constructors

constructor

Methods

downloadInvoice getConsumption listDiscounts listInvoices

Constructors

constructor

new API(client): Billing.v2alpha1.API
Parameters
- client: Client
Returns Billing.v2alpha1.API
Inherited from ParentAPI.constructor
- Defined in packages/clients/src/scw/api.ts:9

Methods

downloadInvoice

downloadInvoice(request): Promise<Blob>
Download an invoice. Download a specific invoice, specified by its ID.
Parameters
- request: Readonly<Billing.v2alpha1.DownloadInvoiceRequest>
  The request DownloadInvoiceRequest
Returns Promise<Blob>
A Promise of Blob
- Defined in packages/clients/src/api/billing/v2alpha1/api.gen.ts:91

getConsumption

getConsumption(request?): Promise<GetConsumptionResponse>
Get current month's consumption. The consumption reflects the amount of money you have spent for the products you have used. The consumption value is monetary and is not computed in real time.
Parameters
- request: Readonly<GetConsumptionRequest> = {}
  The request GetConsumptionRequest
Returns Promise<GetConsumptionResponse>
A Promise of GetConsumptionResponse
- Defined in packages/clients/src/api/billing/v2alpha1/api.gen.ts:39

listDiscounts

listDiscounts(request?): Promise<Billing.v2alpha1.ListDiscountsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Billing.v2alpha1.Discount[], void, void>);
all: (() => Promise<Billing.v2alpha1.Discount[]>);
}
List all user's discounts. List all discounts for an organization and usable categories/products/offers/references/regions/zones where the discount can be applied.
Parameters
- request: Readonly<Billing.v2alpha1.ListDiscountsRequest> = {}
  The request ListDiscountsRequest
Returns Promise<Billing.v2alpha1.ListDiscountsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Billing.v2alpha1.Discount[], void, void>);
all: (() => Promise<Billing.v2alpha1.Discount[]>);
}
A Promise of ListDiscountsResponse
- Defined in packages/clients/src/api/billing/v2alpha1/api.gen.ts:127

listInvoices

listInvoices(request?): Promise<Billing.v2alpha1.ListInvoicesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Billing.v2alpha1.Invoice[], void, void>);
all: (() => Promise<Billing.v2alpha1.Invoice[]>);
}
List invoices. List all your invoices, filtering by start_date and invoice_type. Each invoice has its own ID.
Parameters
- request: Readonly<Billing.v2alpha1.ListInvoicesRequest> = {}
  The request ListInvoicesRequest
Returns Promise<Billing.v2alpha1.ListInvoicesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Billing.v2alpha1.Invoice[], void, void>);
all: (() => Promise<Billing.v2alpha1.Invoice[]>);
}
A Promise of ListInvoicesResponse
- Defined in packages/clients/src/api/billing/v2alpha1/api.gen.ts:82

Class API

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Billing.v2alpha1.API

Methods

downloadInvoice

Parameters

Returns Promise<Blob>

getConsumption

Parameters

Returns Promise<GetConsumptionResponse>

listDiscounts

Parameters

Returns Promise<Billing.v2alpha1.ListDiscountsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Billing.v2alpha1.Discount[], void, void>);
all: (() => Promise<Billing.v2alpha1.Discount[]>);
}

listInvoices

Parameters

Returns Promise<Billing.v2alpha1.ListInvoicesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Billing.v2alpha1.Invoice[], void, void>);
all: (() => Promise<Billing.v2alpha1.Invoice[]>);
}

Settings

On This Page

Class API

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Billing.v2alpha1.API

Methods

downloadInvoice

Parameters

Returns Promise<Blob>

getConsumption

Parameters

Returns Promise<GetConsumptionResponse>

listDiscounts

Parameters

Returns Promise<Billing.v2alpha1.ListDiscountsResponse> & { [asyncIterator]: (() => AsyncGenerator<Billing.v2alpha1.Discount[], void, void>); all: (() => Promise<Billing.v2alpha1.Discount[]>); }

listInvoices

Parameters

Returns Promise<Billing.v2alpha1.ListInvoicesResponse> & { [asyncIterator]: (() => AsyncGenerator<Billing.v2alpha1.Invoice[], void, void>); all: (() => Promise<Billing.v2alpha1.Invoice[]>); }

Settings

On This Page

Returns Promise<Billing.v2alpha1.ListDiscountsResponse> & {
[asyncIterator]: (() => AsyncGenerator<Billing.v2alpha1.Discount[], void, void>);
all: (() => Promise<Billing.v2alpha1.Discount[]>);
}

Returns Promise<Billing.v2alpha1.ListInvoicesResponse> & {
[asyncIterator]: (() => AsyncGenerator<Billing.v2alpha1.Invoice[], void, void>);
all: (() => Promise<Billing.v2alpha1.Invoice[]>);
}