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 exportInvoices getInvoice listConsumptions listDiscounts listInvoices listTaxes

Constructors

constructor

new API(client): Billing.v2beta1.API
Parameters
- client: Client
Returns Billing.v2beta1.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.v2beta1.DownloadInvoiceRequest>
  The request DownloadInvoiceRequest
Returns Promise<Blob>
A Promise of Blob
- Defined in packages/clients/src/api/billing/v2beta1/api.gen.ts:195

exportInvoices

exportInvoices(request?): Promise<Blob>
Export invoices. Export invoices in a CSV file.
Parameters
- request: Readonly<ExportInvoicesRequest> = {}
  The request ExportInvoicesRequest
Returns Promise<Blob>
A Promise of Blob
- Defined in packages/clients/src/api/billing/v2beta1/api.gen.ts:156

getInvoice

getInvoice(request): Promise<Billing.v2beta1.Invoice>
Get an invoice. Get a specific invoice, specified by its ID.
Parameters
- request: Readonly<GetInvoiceRequest>
  The request GetInvoiceRequest
Returns Promise<Billing.v2beta1.Invoice>
A Promise of Invoice
- Defined in packages/clients/src/api/billing/v2beta1/api.gen.ts:180

listConsumptions

listConsumptions(request?): Promise<ListConsumptionsResponse> & {
[asyncIterator]: (() => AsyncGenerator<ListConsumptionsResponseConsumption[], void, void>);
all: (() => Promise<ListConsumptionsResponseConsumption[]>);
}
Get monthly consumption. Consumption allows you to retrieve your past or current consumption cost, by project or category.
Parameters
- request: Readonly<ListConsumptionsRequest> = {}
  The request ListConsumptionsRequest
Returns Promise<ListConsumptionsResponse> & {
[asyncIterator]: (() => AsyncGenerator<ListConsumptionsResponseConsumption[], void, void>);
all: (() => Promise<ListConsumptionsResponseConsumption[]>);
}
A Promise of ListConsumptionsResponse
- Defined in packages/clients/src/api/billing/v2beta1/api.gen.ts:81

listDiscounts

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

listInvoices

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

listTaxes

listTaxes(request?): Promise<ListTaxesResponse> & {
[asyncIterator]: (() => AsyncGenerator<ListTaxesResponseTax[], void, void>);
all: (() => Promise<ListTaxesResponseTax[]>);
}
Get monthly consumption taxes. Consumption Tax allows you to retrieve your past or current tax charges, by project or category.
Parameters
- request: Readonly<ListTaxesRequest> = {}
  The request ListTaxesRequest
Returns Promise<ListTaxesResponse> & {
[asyncIterator]: (() => AsyncGenerator<ListTaxesResponseTax[], void, void>);
all: (() => Promise<ListTaxesResponseTax[]>);
}
A Promise of ListTaxesResponse
- Defined in packages/clients/src/api/billing/v2beta1/api.gen.ts:114

Class API

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Billing.v2beta1.API

Methods

downloadInvoice

Parameters

Returns Promise<Blob>

exportInvoices

Parameters

Returns Promise<Blob>

getInvoice

Parameters

Returns Promise<Billing.v2beta1.Invoice>

listConsumptions

Parameters

Returns Promise<ListConsumptionsResponse> & {
[asyncIterator]: (() => AsyncGenerator<ListConsumptionsResponseConsumption[], void, void>);
all: (() => Promise<ListConsumptionsResponseConsumption[]>);
}

listDiscounts

Parameters

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

listInvoices

Parameters

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

listTaxes

Parameters

Returns Promise<ListTaxesResponse> & {
[asyncIterator]: (() => AsyncGenerator<ListTaxesResponseTax[], void, void>);
all: (() => Promise<ListTaxesResponseTax[]>);
}

Settings

On This Page

Class API

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Billing.v2beta1.API

Methods

downloadInvoice

Parameters

Returns Promise<Blob>

exportInvoices

Parameters

Returns Promise<Blob>

getInvoice

Parameters

Returns Promise<Billing.v2beta1.Invoice>

listConsumptions

Parameters

Returns Promise<ListConsumptionsResponse> & { [asyncIterator]: (() => AsyncGenerator<ListConsumptionsResponseConsumption[], void, void>); all: (() => Promise<ListConsumptionsResponseConsumption[]>); }

listDiscounts

Parameters

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

listInvoices

Parameters

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

listTaxes

Parameters

Returns Promise<ListTaxesResponse> & { [asyncIterator]: (() => AsyncGenerator<ListTaxesResponseTax[], void, void>); all: (() => Promise<ListTaxesResponseTax[]>); }

Settings

On This Page

Returns Promise<ListConsumptionsResponse> & {
[asyncIterator]: (() => AsyncGenerator<ListConsumptionsResponseConsumption[], void, void>);
all: (() => Promise<ListConsumptionsResponseConsumption[]>);
}

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

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

Returns Promise<ListTaxesResponse> & {
[asyncIterator]: (() => AsyncGenerator<ListTaxesResponseTax[], void, void>);
all: (() => Promise<ListTaxesResponseTax[]>);
}