Class Invoices

Invoices - object-oriented interface

export

Hierarchy

BaseAPI
- Invoices

Index

Constructors

constructor

Methods

Constructors

constructor

new Invoices(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): Invoices

Inherited from BaseAPI.constructor
- Defined in src/openapi/base.ts:52
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns Invoices

Methods

commitRecalculation

commitRecalculation(invoiceId: string, recalculationId: string, options?: any): Promise<AxiosResponse<InvoiceRecalculationResult>>

- Defined in src/openapi/api.ts:4877
This endpoint allows you to commit invoice recalculation.

summary
Commit invoice recalculation

throws
{RequiredError}

memberof
Invoices

Parameters
- invoiceId: string
  
  Invoice ID
- recalculationId: string
  
  Recalculation ID
- Optional options: any
Returns Promise<AxiosResponse<InvoiceRecalculationResult>>

create

create(invoiceParams: InvoiceParams, options?: any): Promise<AxiosResponse<InvoiceResult>>

- Defined in src/openapi/api.ts:4889
This endpoint allows you to create invoices.

summary
Create an invoice

throws
{RequiredError}

memberof
Invoices

Parameters
- invoiceParams: InvoiceParams
- Optional options: any
Returns Promise<AxiosResponse<InvoiceResult>>

createRecalculation

createRecalculation(invoiceId: string, invoiceRecalculationParams: InvoiceRecalculationParams, options?: any): Promise<AxiosResponse<InvoiceRecalculationResult>>

- Defined in src/openapi/api.ts:4902
This endpoint allows you to recalculate invoices.

summary
Create invoice recalculation

throws
{RequiredError}

memberof
Invoices

Parameters
- invoiceId: string
  
  Invoice ID
- invoiceRecalculationParams: InvoiceRecalculationParams
- Optional options: any
Returns Promise<AxiosResponse<InvoiceRecalculationResult>>

createRefund

createRefund(invoiceId: string, invoiceRefundParams: InvoiceRefundParams, options?: any): Promise<AxiosResponse<InvoiceRefundResult>>

- Defined in src/openapi/api.ts:4915
This endpoint allows you to create invoice refunds.

summary
Create invoice refund

throws
{RequiredError}

memberof
Invoices

Parameters
- invoiceId: string
  
  Invoice ID
- invoiceRefundParams: InvoiceRefundParams
- Optional options: any
Returns Promise<AxiosResponse<InvoiceRefundResult>>

list

list(customerId?: string, startingAfter?: string, subscriptionId?: string, options?: any): Promise<AxiosResponse<InvoiceListResult>>

- Defined in src/openapi/api.ts:4929
This endpoint allows you to retrieve a list of all invoices.

summary
List invoices

throws
{RequiredError}

memberof
Invoices

Parameters
- Optional customerId: string
- Optional startingAfter: string
- Optional subscriptionId: string
- Optional options: any
Returns Promise<AxiosResponse<InvoiceListResult>>

listRefunds

listRefunds(invoiceId: string, options?: any): Promise<AxiosResponse<InvoiceRefundListResult>>

- Defined in src/openapi/api.ts:4941
This endpoint allows you to retrieve a list of a particular invoice refunds.

summary
List invoice refunds

throws
{RequiredError}

memberof
Invoices

Parameters
- invoiceId: string
  
  Invoice ID
- Optional options: any
Returns Promise<AxiosResponse<InvoiceRefundListResult>>

retrieve

retrieve(invoiceId: string, options?: any): Promise<AxiosResponse<InvoiceResult>>

- Defined in src/openapi/api.ts:4953
This endpoint allows you to retrieve the invoice details.

summary
Retrieve an invoice

throws
{RequiredError}

memberof
Invoices

Parameters
- invoiceId: string
  
  Invoice ID
- Optional options: any
Returns Promise<AxiosResponse<InvoiceResult>>

retrieveByCustomId

retrieveByCustomId(customId: string, options?: any): Promise<AxiosResponse<InvoiceResult>>

- Defined in src/openapi/api.ts:4965
This endpoint allows you to retrieve invoice details by its custom_id.

summary
Retrieve an invoice by custom_id

throws
{RequiredError}

memberof
Invoices

Parameters
- customId: string
- Optional options: any
Returns Promise<AxiosResponse<InvoiceResult>>

Generated using TypeDoc