Interface: FlowOpenOptions

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:544

Extends

FlowStartOptions

FlowOpenOptions and its parent FlowStartOptions are active interfaces. Some migration comments in the TypeScript source are stale: the checkout runtime still reads older fields. The groups below reflect current behavior.

Properties

confirmClose?

optional confirmClose?: () => boolean | Promise<boolean>

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:580

Merchant-supplied "are you sure?" gate. Resolved true allows the close to proceed, false keeps the frame open. Replaces the previous boolean + label/title strings combo. Off when omitted.

Returns

boolean | Promise<boolean>

context?

optional context?: Record<string, unknown>

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:513

Inherited from

FlowStartOptions.context

continuity?

optional continuity?: ContinuityScope

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:554

Per-call continuity override.

frame?

optional frame?: FrameMode

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:560

Frame modality. Was previously mode — renamed because mode now means the test/live/preview environment (see below).

metadata?

optional metadata?: Record<string, string>

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:593

Per-call Stripe-customer metadata. Eager string values only — for window-global lookups use the page-global PlandalfConfig.metadata thunk form. Wins over PlandalfConfig.metadata on overlap.

mode?

optional mode?: "test" | "live" | "preview"

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:567

Session mode request. The inspected SDK session endpoint permits test mode when the offer has test mode enabled or the caller is an authenticated member of its organization. It does not use a JWT mode claim or test-domain setting for this decision. Without a Stripe test integration, payment selection falls back to live Stripe even for a test session. Verify the selected payment connection before submitting payment. The SDK session endpoint does not enable preview.

price?

optional price?: string | string[]

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:601

Plandalf price lookup key(s) to sell, using this offer as the checkout design. Replaces the offer's own items — e.g. a MemberPress membership page passes the price linked to that membership. Declarative: data-plandalf-price="gold-monthly,gold-setup-fee".

optional promo?: PromoContext

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:515

Inherited from

FlowStartOptions.promo

properties?

optional properties?: Record<string, unknown>

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:586

Per-call form-field prefill defaults. Wins over PlandalfConfig.properties on overlap. See specs/sdk-checkout-config.md.

session?

optional session?: string | null

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:551

Session continuity token (cks_…). Pass explicitly to resume a specific session server-side — cross-device handoff, email "continue your checkout" links, anywhere the merchant has a token in hand. Pass null to force a fresh session and skip any stored token. Omit entirely to let the SDK auto-detect.

sessionId?

optional sessionId?: string

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:529

Reuse an existing session UUID instead of creating a fresh one. Used by the auto-resume path to finalize against the ORIGINAL session after a redirect-based auth bounce — creating a new session would lose the draft upsell invoice that needs settling.

Inherited from

FlowStartOptions.sessionId

size?

optional size?: FlowSize | { h: string; w: string; }

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:573

Size of the modal panel. Either a named preset OR an explicit { w, h } object for one-off cases. Defaults to 'standard'.

templateId?

optional templateId?: string

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:505

Inherited from

FlowStartOptions.templateId

templateSlug?

optional templateSlug?: string

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:504

Inherited from

FlowStartOptions.templateSlug

user?

optional user?: string

Defined in: ../../../../plandalf/numi/packages/sdk/src/core/types.ts:512

Customer JWT for THIS call only — overrides the SDK-wide identity from plandalf.setUser() or the user init option. Useful for "buy as customer" admin tooling, impersonation flows, or offers that need a different identity than the global one. The value is the raw JWT string.