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;
    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>;
}

Index

Properties

status session paymentElement error

Methods

reload updateEmail updateShippingAddress applyPromotionCode removePromotionCode runServerUpdate clearPaymentOption confirm

Properties

`Readonly`status

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

The current hook or controller lifecycle status.

`Readonly`session

session: null | Checkout.Session

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

`Readonly`paymentElement

paymentElement: null | CheckoutPaymentElement

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

`Readonly`error

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>
- Defined in src/types/Checkout.ts:145

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>
- Defined in src/types/Checkout.ts:147

updateShippingAddress

updateShippingAddress(params: UpdateShippingAddressParams): Promise<void>
Sets or clears the customer's shipping address.
Parameters
- params: UpdateShippingAddressParams
Returns Promise<void>
- Defined in src/types/Checkout.ts:149

applyPromotionCode

applyPromotionCode(promotionCode: string): Promise<void>
Applies a promotion code entered by the customer.
Parameters
- promotionCode: string
Returns Promise<void>
- Defined in src/types/Checkout.ts:151

removePromotionCode

removePromotionCode(): Promise<void>
Removes the currently applied promotion code, if any.

Returns Promise<void>
- Defined in src/types/Checkout.ts:153

runServerUpdate

runServerUpdate(serverUpdate: () => Promise<void>): Promise<void>
Runs a server update and refreshes the local Checkout Session.
Parameters
- serverUpdate: () => Promise<void>
Returns Promise<void>
- Defined in src/types/Checkout.ts:155

clearPaymentOption

clearPaymentOption(): Promise<void>
Clears the customer's currently selected payment option.

Returns Promise<void>
- Defined in src/types/Checkout.ts:157

confirm

confirm(): Promise<Checkout.Result>
Confirms the Checkout Session for the selected payment option.

Returns Promise<Checkout.Result>
- Defined in src/types/Checkout.ts:159