Interface Session

A view of the Checkout Session that represents the customer's checkout.

Checkout Session Private Preview

interface Session {
    id: string;
    businessName?: string;
    livemode: boolean;
    currency: string;
    minorUnitsAmountDivisor?: number;
    presentmentDetails?: PresentmentDetails;
    email?: string;
    paymentOption?: Checkout.PaymentOptionDisplayData;
    shippingAddress?: ShippingAddress;
    orderSummaryItems: OneTimePriceOrderSummaryItem[];
    discountAmounts: DiscountAmount[];
    tax?: Tax;
    taxAmounts?: TaxAmount[];
    totals: Totals;
    status: SessionStatus;
    lastPaymentError?: StripeError<ErrorCode>;
}

Properties

id businessName? livemode currency minorUnitsAmountDivisor? presentmentDetails? email? paymentOption? shippingAddress? orderSummaryItems discountAmounts tax? taxAmounts? totals status lastPaymentError?

Properties

id

id: string

The Checkout Session ID.

OptionalbusinessName

businessName?: string

The business name configured in Stripe Business Public Details.

livemode

livemode: boolean

Whether the Checkout Session is in live mode.

currency

currency: string

Three-letter ISO 4217 currency code in lowercase.

OptionalminorUnitsAmountDivisor

minorUnitsAmountDivisor?: number

Factor used to convert minor currency units to major units.

OptionalpresentmentDetails

presentmentDetails?: PresentmentDetails

Currency presentation details for the customer.

Optionalemail

email?: string

The customer's email address.

OptionalpaymentOption

paymentOption?: Checkout.PaymentOptionDisplayData

The customer's currently selected payment option.

OptionalshippingAddress

shippingAddress?: ShippingAddress

The customer's shipping contact details and postal address.

orderSummaryItems

orderSummaryItems: OneTimePriceOrderSummaryItem[]

The items the customer is purchasing.

discountAmounts

discountAmounts: DiscountAmount[]

Aggregate discount amounts for all order items.

Optionaltax

tax?: Tax

Tax computation status.

OptionaltaxAmounts

taxAmounts?: TaxAmount[]

Aggregate amounts for each tax rate after Checkout computes tax.

totals

totals: Totals

Tax and discount breakdown for the computed session total.

status

status: SessionStatus

Lifecycle status of the Checkout Session.

OptionallastPaymentError

lastPaymentError?: StripeError<ErrorCode>

The error encountered the last time confirmation ran.

Settings

Member Visibility

On This Page

Properties