Class PaymentLinksResource

Index

Constructors

Methods

create retrieve update list listLineItems

Constructors

constructor

new PaymentLinksResource(): PaymentLinksResource
Returns PaymentLinksResource

Methods

create

create(
params: Stripe.PaymentLinkCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.PaymentLink>>
Creates a payment link.
Parameters
- params: Stripe.PaymentLinkCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.PaymentLink>>
- Defined in node_modules/stripe/types/PaymentLinksResource.d.ts:2237

retrieve

retrieve(
    id: string,
    params?: PaymentLinkRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.PaymentLink>>
Retrieve a payment link.
Parameters
- id: string
- Optionalparams: PaymentLinkRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.PaymentLink>>
- Defined in node_modules/stripe/types/PaymentLinksResource.d.ts:2245
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.PaymentLink>>
Retrieve a payment link.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.PaymentLink>>
- Defined in node_modules/stripe/types/PaymentLinksResource.d.ts:2250

update

update(
    id: string,
    params?: Stripe.PaymentLinkUpdateParams,
    options?: RequestOptions,
): Promise<Response<Stripe.PaymentLink>>
Updates a payment link.
Parameters
- id: string
- Optionalparams: Stripe.PaymentLinkUpdateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.PaymentLink>>
- Defined in node_modules/stripe/types/PaymentLinksResource.d.ts:2258

list

list(
params?: PaymentLinkListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.PaymentLink>
Returns a list of your payment links.
Parameters
- Optionalparams: PaymentLinkListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.PaymentLink>
- Defined in node_modules/stripe/types/PaymentLinksResource.d.ts:2267
list(options?: RequestOptions): ApiListPromise<Stripe.PaymentLink>
Returns a list of your payment links.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.PaymentLink>
- Defined in node_modules/stripe/types/PaymentLinksResource.d.ts:2271

listLineItems

listLineItems(
    id: string,
    params?: PaymentLinkListLineItemsParams,
    options?: RequestOptions,
): ApiListPromise<Stripe.LineItem>
When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
Parameters
- id: string
- Optionalparams: PaymentLinkListLineItemsParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.LineItem>
- Defined in node_modules/stripe/types/PaymentLinksResource.d.ts:2276
listLineItems(
id: string,
options?: RequestOptions,
): ApiListPromise<Stripe.LineItem>
When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.LineItem>
- Defined in node_modules/stripe/types/PaymentLinksResource.d.ts:2281