Interface CheckoutSession

Export

CheckoutSession

Hierarchy

  • CheckoutSession

Properties

account_id amount_total cancel_url? created_at currency customer_details? customer_id? expires_at? id line_items metadata? payment_intent_id payment_method_types status success_url? updated_at url

Properties

account_id

account_id: string

The ID of the account for this checkout session.

Memberof

CheckoutSession

amount_total

amount_total: number

Total of all items, in currency minor units.

Memberof

CheckoutSession

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

CheckoutSession

created_at

created_at: string

Time at which the object was created.

Memberof

CheckoutSession

currency

currency: CheckoutSessionCurrency

Three-letter ISO currency code, in lowercase.

Memberof

CheckoutSession

Optional customer_details

customer_details?: CustomerDetails

The customer details.

Memberof

CheckoutSession

Optional customer_id

customer_id?: string

The ID of the customer for this checkout session.

Memberof

CheckoutSession

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

CheckoutSession

id

id: string

Unique identifier for the object.

Memberof

CheckoutSession

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

CheckoutSession

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

CheckoutSession

Type declaration

  • [key: string]: string

payment_intent_id

payment_intent_id: string

The ID of the payment intent for checkout session.

Memberof

CheckoutSession

payment_method_types

payment_method_types: CheckoutSessionPaymentMethodTypes[]

A list of the types of payment methods (e.g. card) this checkout session is allowed to accept.

Memberof

CheckoutSession

status

status: CheckoutSessionStatus

The status of the checkout session, one of open, complete or expired. open The checkout session is still in progress. Payment processing has not started. complete The checkout session is complete. Payment processing may still be in progress. expired The checkout session has expired. No further processing will occur.

Memberof

CheckoutSession

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

CheckoutSession

updated_at

updated_at: string

Time at which the object was last updated.

Memberof

CheckoutSession

url

url: string

The URL to the checkout session. Redirect customers to this URL to take them to checkout.

Memberof

CheckoutSession

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc