Interface UseResult

Reactive Checkout state and controller methods returned by useCheckout.

Checkout Session Private Preview

interface UseResult {
    status:
        | "error"
        | "ready"
        | "updating"
        | "confirming"
        | "idle"
        | "loading";
    session: null
    | Checkout.Session;
    paymentElement: null | CheckoutPaymentElement;
    currencySelectorElement: null | CheckoutCurrencySelectorElement;
    error: null | StripeError<ErrorCode>;
    reload(): Promise<void>;
    updateEmail(email: null | string): Promise<void>;
    updateShippingAddress(params: UpdateShippingAddressParams): Promise<void>;
    applyPromotionCode(promotionCode: string): Promise<void>;
    removePromotionCode(): Promise<void>;
    runServerUpdate(serverUpdate: () => Promise<void>): Promise<void>;
    clearPaymentOption(): Promise<void>;
    confirm(): Promise<Checkout.Result>;
}

Properties

status session paymentElement currencySelectorElement error

Methods

reload updateEmail updateShippingAddress applyPromotionCode removePromotionCode runServerUpdate clearPaymentOption confirm

Properties

Readonlystatus

status: "error" | "ready" | "updating" | "confirming" | "idle" | "loading"

The current hook or controller lifecycle status.

Readonlysession

session: null | Checkout.Session

The latest session snapshot, or null before Checkout is ready.

ReadonlypaymentElement

paymentElement: null | CheckoutPaymentElement

The Checkout-owned Payment Element, or null before Checkout is ready.

ReadonlycurrencySelectorElement

currencySelectorElement: null | CheckoutCurrencySelectorElement

The Currency Selector Element, or null before Checkout is ready or when it is unavailable for the Checkout Session.

Readonlyerror

error: null | StripeError<ErrorCode>

The initialization error when status is error; otherwise null.

Methods

reload

  • reload(): Promise<void>

    Fetches fresh configuration and replaces the current native controller.

    Returns Promise<void>

updateEmail

  • updateEmail(email: null | string): Promise<void>

    Updates the customer's email address. Pass null to clear it.

    Parameters

    • email: null | string

    Returns Promise<void>

updateShippingAddress

applyPromotionCode

  • applyPromotionCode(promotionCode: string): Promise<void>

    Applies a promotion code entered by the customer.

    Parameters

    • promotionCode: string

    Returns Promise<void>

removePromotionCode

  • removePromotionCode(): Promise<void>

    Removes the currently applied promotion code, if any.

    Returns Promise<void>

runServerUpdate

  • runServerUpdate(serverUpdate: () => Promise<void>): Promise<void>

    Runs a server update and refreshes the local Checkout Session.

    Parameters

    • serverUpdate: () => Promise<void>

    Returns Promise<void>

clearPaymentOption

  • clearPaymentOption(): Promise<void>

    Clears the customer's currently selected payment option.

    Returns Promise<void>

confirm

  • confirm(): Promise<Checkout.Result>

    Confirms the Checkout Session for the selected payment option.

    Returns Promise<Checkout.Result>

Settings

Member Visibility

On This Page

Properties
Methods