Interface CheckoutSessionCreateParams

Export

CheckoutSessionCreateParams

Hierarchy

  • CheckoutSessionCreateParams

Properties

cancel_url? customer_email? customer_id? expires_at? line_items metadata? payment_intent_data success_url?

Properties

Optional cancel_url

cancel_url?: string

If set, checkout will display a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.

Memberof

CheckoutSessionCreateParams

Optional customer_email

customer_email?: string

If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once a session is complete, use the customer_id field to fetch the customer.

Memberof

CheckoutSessionCreateParams

Optional customer_id

customer_id?: string

The ID of the customer for this checkout session.

Memberof

CheckoutSessionCreateParams

Optional expires_at

expires_at?: string

The due date for the checkout session. After this date the customer will no longer be able to complete the checkout session.

Memberof

CheckoutSessionCreateParams

line_items

line_items: CheckoutSessionLineItem[]

A list of items the customer is purchasing. The maximum is 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.

Memberof

CheckoutSessionCreateParams

Optional metadata

metadata?: {
    [key: string]: string;
}

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value (i.e. \'\' or null) to them. All keys can be unset by posting an empty value (i.e. {} or null) to metadata.

Memberof

CheckoutSessionCreateParams

Type declaration

  • [key: string]: string

payment_intent_data

payment_intent_data: PaymentIntentDataCreateParams

A subset of parameters to be passed to the payment intent creation.

Memberof

CheckoutSessionCreateParams

Optional success_url

success_url?: string

The URL to which we should send customers when payment is complete. It is recommended that you supply this value, but if none is provided, a generic success landing page will be used.

Memberof

CheckoutSessionCreateParams

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc