Beignet API reference
    Preparing search index...

    Interface CheckoutSession

    Hosted checkout session returned by a payment provider.

    interface CheckoutSession {
        clientSecret?: string;
        customerId?: string;
        id: string;
        metadata?: PaymentMetadata;
        mode: PaymentCheckoutMode;
        provider: string;
        raw?: unknown;
        status?: string;
        url?: string;
    }
    Index
    clientSecret? customerId? id metadata? mode provider raw? status? url?
    clientSecret?: string

    Client secret, when the provider supports embedded checkout.

    customerId?: string

    Provider customer ID, when known.

    id: string

    Provider session ID.

    metadata?: PaymentMetadata

    Provider metadata.

    mode: PaymentCheckoutMode

    Checkout mode.

    provider: string

    Provider name.

    raw?: unknown

    Raw provider response for app-owned escape hatches.

    status?: string

    Provider status, when known.

    url?: string

    Hosted checkout URL, when the provider returns one.

    Settings
    Member Visibility

    On This Page
    Properties