Class InvoicePaymentsResource

Index

Constructors

Methods

Constructors

constructor

new InvoicePaymentsResource(): InvoicePaymentsResource
Returns InvoicePaymentsResource

Methods

retrieve

retrieve(
    id: string,
    params?: InvoicePaymentRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.InvoicePayment>>
Retrieves the invoice payment with the given ID.
Parameters
- id: string
- Optionalparams: InvoicePaymentRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.InvoicePayment>>
- Defined in node_modules/stripe/types/InvoicePaymentsResource.d.ts:68
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.InvoicePayment>>
Retrieves the invoice payment with the given ID.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.InvoicePayment>>
- Defined in node_modules/stripe/types/InvoicePaymentsResource.d.ts:73

list

list(
params?: Stripe.InvoicePaymentListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.InvoicePayment>
When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
Parameters
- Optionalparams: Stripe.InvoicePaymentListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.InvoicePayment>
- Defined in node_modules/stripe/types/InvoicePaymentsResource.d.ts:81
list(options?: RequestOptions): ApiListPromise<Stripe.InvoicePayment>
When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.InvoicePayment>
- Defined in node_modules/stripe/types/InvoicePaymentsResource.d.ts:85