Beignet API reference
    Preparing search index...

    Interface CreateCheckoutSessionInput

    Input for creating a hosted checkout session.

    interface CreateCheckoutSessionInput {
        cancelUrl: string;
        clientReferenceId?: string;
        customerId?: string;
        idempotencyKey?: string;
        lineItems: readonly PaymentCheckoutLineItem[];
        metadata?: PaymentMetadata;
        mode: PaymentCheckoutMode;
        successUrl: string;
    }
    Index
    cancelUrl clientReferenceId? customerId? idempotencyKey? lineItems metadata? mode successUrl
    cancelUrl: string

    URL the provider redirects to when checkout is canceled.

    clientReferenceId?: string

    App-owned reference copied into the provider session.

    customerId?: string

    Existing provider customer ID, when known.

    idempotencyKey?: string

    Provider idempotency key for this external call.

    lineItems: readonly PaymentCheckoutLineItem[]

    Line items to include in checkout.

    metadata?: PaymentMetadata

    Provider metadata.

    mode: PaymentCheckoutMode

    One-time payment or subscription checkout.

    successUrl: string

    URL the provider redirects to after successful checkout.

    Settings
    Member Visibility

    On This Page
    Properties