Class BillingAPI

Dedibox Phoenix Billing API.

Hierarchy

API
- BillingAPI

Index

Constructors

constructor

Methods

canOrder downloadInvoice downloadRefund getInvoice getRefund listInvoices listRefunds

Constructors

constructor

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

Methods

canOrder

canOrder(request?): Promise<CanOrderResponse>
Parameters
- request: Readonly<BillingApiCanOrderRequest> = {}
Returns Promise<CanOrderResponse>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1264

downloadInvoice

downloadInvoice(request): Promise<Blob>
Parameters
- request: Readonly<Dedibox.v1.BillingApiDownloadInvoiceRequest>
Returns Promise<Blob>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1216

downloadRefund

downloadRefund(request): Promise<Blob>
Parameters
- request: Readonly<Dedibox.v1.BillingApiDownloadRefundRequest>
Returns Promise<Blob>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1256

getInvoice

getInvoice(request): Promise<Dedibox.v1.Invoice>
Parameters
- request: Readonly<Dedibox.v1.BillingApiGetInvoiceRequest>
Returns Promise<Dedibox.v1.Invoice>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1207

getRefund

getRefund(request): Promise<Refund>
Parameters
- request: Readonly<Dedibox.v1.BillingApiGetRefundRequest>
Returns Promise<Refund>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1247

listInvoices

listInvoices(request?): Promise<Dedibox.v1.ListInvoicesResponse> & {
[asyncIterator]: (() => AsyncGenerator<InvoiceSummary[], void, void>);
all: (() => Promise<InvoiceSummary[]>);
}
Parameters
- request: Readonly<Dedibox.v1.BillingApiListInvoicesRequest> = {}
Returns Promise<Dedibox.v1.ListInvoicesResponse> & {
[asyncIterator]: (() => AsyncGenerator<InvoiceSummary[], void, void>);
all: (() => Promise<InvoiceSummary[]>);
}
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1204

listRefunds

listRefunds(request?): Promise<ListRefundsResponse> & {
[asyncIterator]: (() => AsyncGenerator<RefundSummary[], void, void>);
all: (() => Promise<RefundSummary[]>);
}
Parameters
- request: Readonly<Dedibox.v1.BillingApiListRefundsRequest> = {}
Returns Promise<ListRefundsResponse> & {
[asyncIterator]: (() => AsyncGenerator<RefundSummary[], void, void>);
all: (() => Promise<RefundSummary[]>);
}
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1244

Class BillingAPI

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BillingAPI

Methods

canOrder

Parameters

Returns Promise<CanOrderResponse>

downloadInvoice

Parameters

Returns Promise<Blob>

downloadRefund

Parameters

Returns Promise<Blob>

getInvoice

Parameters

Returns Promise<Dedibox.v1.Invoice>

getRefund

Parameters

Returns Promise<Refund>

listInvoices

Parameters

Returns Promise<Dedibox.v1.ListInvoicesResponse> & {
[asyncIterator]: (() => AsyncGenerator<InvoiceSummary[], void, void>);
all: (() => Promise<InvoiceSummary[]>);
}

listRefunds

Parameters

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

Settings

On This Page

Class BillingAPI

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns BillingAPI

Methods

canOrder

Parameters

Returns Promise<CanOrderResponse>

downloadInvoice

Parameters

Returns Promise<Blob>

downloadRefund

Parameters

Returns Promise<Blob>

getInvoice

Parameters

Returns Promise<Dedibox.v1.Invoice>

getRefund

Parameters

Returns Promise<Refund>

listInvoices

Parameters

Returns Promise<Dedibox.v1.ListInvoicesResponse> & { [asyncIterator]: (() => AsyncGenerator<InvoiceSummary[], void, void>); all: (() => Promise<InvoiceSummary[]>); }

listRefunds

Parameters

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

Settings

On This Page

Returns Promise<Dedibox.v1.ListInvoicesResponse> & {
[asyncIterator]: (() => AsyncGenerator<InvoiceSummary[], void, void>);
all: (() => Promise<InvoiceSummary[]>);
}

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