Plandalf
Browse Packages

Interface: FlowStartOptions

Defined in: packages/sdk/src/core/types.ts:489

Extended by

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

Properties

context?

optional context?: Record<string, unknown>

Defined in: packages/sdk/src/core/types.ts:499

environment?

optional environment?: "test" | "live"

Defined in: packages/sdk/src/core/types.ts:508

Force the server into a specific environment when creating the session. 'test' routes the checkout to the org's Stripe test integration (super-admin only). Omit to let the server decide based on the caller's identity + route mode.

headless?

optional headless?: boolean

Defined in: packages/sdk/src/core/types.ts:500

promo?

optional promo?: PromoContext

Defined in: packages/sdk/src/core/types.ts:501

sessionId?

optional sessionId?: string

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

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: packages/sdk/src/core/types.ts:491

templateSlug?

optional templateSlug?: string

Defined in: packages/sdk/src/core/types.ts:490

user?

optional user?: string

Defined in: packages/sdk/src/core/types.ts:498

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