Class TopupsResource

Index

Constructors

Methods

create retrieve update list cancel

Constructors

constructor

new TopupsResource(): TopupsResource
Returns TopupsResource

Methods

create

create(
params: TopupCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.Topup>>
Top up the balance of an account
Parameters
- params: TopupCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Topup>>
- Defined in node_modules/stripe/types/TopupsResource.d.ts:108

retrieve

retrieve(
    id: string,
    params?: TopupRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Topup>>
Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.
Parameters
- id: string
- Optionalparams: TopupRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Topup>>
- Defined in node_modules/stripe/types/TopupsResource.d.ts:116
retrieve(id: string, options?: RequestOptions): Promise<Response<Stripe.Topup>>
Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Topup>>
- Defined in node_modules/stripe/types/TopupsResource.d.ts:121

update

update(
    id: string,
    params?: TopupUpdateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Topup>>
Updates the metadata of a top-up. Other top-up details are not editable by design.
Parameters
- id: string
- Optionalparams: TopupUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Topup>>
- Defined in node_modules/stripe/types/TopupsResource.d.ts:129

list

list(
params?: Stripe.TopupListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.Topup>
Returns a list of top-ups.
Parameters
- Optionalparams: Stripe.TopupListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Topup>
- Defined in node_modules/stripe/types/TopupsResource.d.ts:138
list(options?: RequestOptions): ApiListPromise<Stripe.Topup>
Returns a list of top-ups.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Topup>
- Defined in node_modules/stripe/types/TopupsResource.d.ts:142

cancel

cancel(
    id: string,
    params?: TopupCancelParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Topup>>
Cancels a top-up. Only pending top-ups can be canceled.
Parameters
- id: string
- Optionalparams: TopupCancelParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Topup>>
- Defined in node_modules/stripe/types/TopupsResource.d.ts:147
cancel(id: string, options?: RequestOptions): Promise<Response<Stripe.Topup>>
Cancels a top-up. Only pending top-ups can be canceled.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Topup>>
- Defined in node_modules/stripe/types/TopupsResource.d.ts:152