Interface: FlowResult

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

Result of a presented flow. Always resolved from plandalf.present() — successful completions and user dismissals both produce a FlowResult so callers can branch on status without needing a .catch. Only real errors (network failure, bad slug, etc.) reject the promise.

Properties

customer?

optional customer?: Customer

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

Convenience — same as result.session.customer.

reason?

optional reason?: "complete" | "cancel" | "escape"

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

When dismissed, why — backdrop / close button / escape.

redirectUrl?

optional redirectUrl?: string

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

Where to redirect the customer after complete (if the offer configures one).

session?

optional session?: CheckoutSessionPayload

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

The full CheckoutSession at the moment of completion (populated on status='complete' only). Invoice + everything else lives in here — inspect via result.session.uuid, result.session.total, result.session.invoice, etc.

status

status: FlowResultStatus

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

'complete' = user finished the flow. 'dismissed' = closed early.