Plandalf
Browse Packages

Interface: FlowStartOptions

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

Extended by

This interface is active. Its options are also inherited by FlowOpenOptions.

Properties

context?

optional context?: Record<string, unknown>

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

environment?

optional environment?: "test" | "live"

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

Legacy name for mode. 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.

headless?

optional headless?: boolean

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

promo?

optional promo?: PromoContext

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

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.

templateId?

optional templateId?: string

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

templateSlug?

optional templateSlug?: string

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

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.

Feature detail