Plandalf docs
Everything you need to build checkout experiences, automate fulfillment, recover revenue, connect integrations, and ship API or SDK-backed commerce flows with Plandalf.
Start with the smallest working path
Learn Plandalf the way you would implement it: one buying action, one Offer, one SDK result, then identity, timers, webhooks, integrations, and automation only when the build asks for them.
- Start with a button or link that opens one test Offer. Do not add identity, timers, webhooks, or campaign logic yet. Open the guide
- Learn how Offers own checkout layout, products, prices, add-ons, payment options, redirects, and completion behavior. Open the guide
- Load the browser SDK or framework wrapper, configure how checkout opens, and listen for the checkout result. Open the guide
- Only pass customer identity, metadata, promo state, or account context after the basic checkout path works. Open the guide
- Move purchase context into fulfillment, CRM, email, records, analytics, or internal systems with webhooks and API calls. Open the guide
Then choose the implementation job
Once the basic checkout path makes sense, pick the checkout, site embed, deadline campaign, API, SDK, webhook, or integration path you are trying to ship.
Create an Offer, choose products and prices, test hosted checkout, then publish the buying surface.
Connect hosted checkout, buy buttons, SDK checkout, or platform-specific installs for Webflow, Shopify, WordPress, React, and Next.js.
Use API authentication, webhooks, SDK events, and sequences when checkout should trigger fulfillment, CRM, email, records, or custom apps.
Create promos, countdowns, CTA links, tiers, embedded promos, and hosted landing pages for deadline campaigns.
Browse the docs
Use the full index when you already know the area you need: Offers, Timers, SDK setup, API authentication, webhooks, platforms, integrations, or affiliate work.
Get started
The short path from first checkout link to a live buying flow.
Introduction Learn Plandalf by adding one commerce primitive at a time: a button, an offer, purchase state, browser events, and backend handoff. Quickstart Install the Plandalf SDK, open an offer from a button, and handle the completed checkout result. Going live Run the final checks before a Plandalf offer accepts real customers and live payments. Components Browse Plandalf's Mintlify-style MDX component library for structure, attention, API docs, navigation, and visual context. Mintlify compatibility Map Mintlify MDX components to the Plandalf docs components that render the same authoring patterns in our theme. MDX component reference Use Plandalf's Mintlify-style MDX components for implementation guides, API docs, examples, prompts, cards, tiles, and agent-aware content. MDX component showcase A review surface for the Plandalf docs components that mirror the Mintlify-style documentation primitives. Steps Use numbered steps to teach setup flows one action at a time, with anchors, custom numbers, icons, and heading-size control. Tabs Use tabs to switch between implementation views such as HTML, React, API, and Agent. Text formatting Use Mintlify-style Markdown text formatting for prose, links, quotes, inline code, and anchors before reaching for heavier MDX components. Code formatting Use Mintlify-style code fence metadata for titled snippets, line numbers, wrapping, highlighted lines, focused lines, diffs, and expandable examples. Lists and tables Use Mintlify-style Markdown lists, task lists, nested lists, and tables for structured docs content without adding extra component chrome. Code groups Use code groups for language choices, framework variants, and synced implementation examples. Tabs and code groups Use tabs and code groups for language, framework, platform, and implementation choices that should stay synchronized across a docs page. Headings Render Mintlify-style explicit Heading components in Plandalf MDX without rewriting imported section structure. Columns Use columns for short side-by-side explanations that are easier to compare than read sequentially. Panel Use panels for supporting context that can sit in the right rail or inline with the page. Accordions Use Mintlify-style accordions to group optional details without interrupting the main implementation path. Expandables Use expandables for optional field details, nested properties, and advanced notes. Badge Use badges for compact status labels, version markers, and small inline metadata in Plandalf docs. Banner Use banners for page-level notices that need to sit above the reader's current task. Callouts Use Mintlify-style callouts and semantic aliases for notes, tips, checks, warnings, danger states, and custom emphasis. Attention components Use Mintlify-style callouts, banners, badges, updates, frames, snippets, and tooltips without turning docs into card-heavy pages. Update component Use Mintlify-style Update blocks for changelog notes, release entries, and docs change history. Update Use update blocks for release notes, docs changelog entries, and filterable component changes. Frames Use frames to present screenshots, media, and browser-like previews with captions. Snippet Use snippets for compact copyable values and reusable MDX fragments inside prose, tables, callouts, and setup instructions. Reusable snippets Reuse MDX fragments and compact copyable values across Plandalf docs with Mintlify-style authoring patterns. Tooltips Use tooltips for short inline definitions that should not interrupt the reader's path. Prompt Use Prompt blocks for copyable AI instructions with concrete constraints, source files, links, and verification steps. Prompt, disclosure, and views Use Mintlify-style prompt blocks, accordions, expandables, views, and visibility controls for progressive docs and agent-aware content. View Use views to switch between human, agent, framework, and implementation-specific versions of the same guidance. Visibility Use visibility controls to keep human-readable docs and agent-only context separate without duplicating pages. Cards Use Mintlify-style cards for links, icons, images, horizontal rows, CTAs, and callout-toned containers. Tiles Use tiles for dense icon grids, component catalogs, and compact next-page navigation. Cards and tiles Use cards for high-value links and tiles for dense visual grids, with icons, images, CTAs, arrows, and callout-style variants. Fields Use fields to document parameters, request body properties, headers, attributes, nested objects, defaults, and validation notes. Responses Document API response structures and fields with Mintlify-compatible response components. Response fields Use response fields to describe API response objects, nested properties, and returned resource shapes. Examples Use request, response, and generic examples to keep copyable code beside the endpoint or concept a reader is viewing. API fields and examples Use fields, response fields, request examples, and response examples to build Mintlify-style API docs with endpoint-aware right-rail samples. API playground pages Build Mintlify-style API reference pages in Plandalf with endpoint metadata, request fields, response fields, examples, multiple responses, SDK samples, schema notes, visibility, and troubleshooting. Visual context components Use Mintlify-style icons, Mermaid diagrams, color swatches, trees, frames, and images to explain implementation context. Images and embeds Add screenshots, media-library images, videos, and iframe embeds to Plandalf docs with Mintlify-style MDX patterns. Files Link downloadable files, static assets, and reference artifacts from Plandalf docs without breaking the reading flow. Color Use color swatches to document Plandalf palette values, tokens, and theme-aware pairs. Icons Use inline icons and icon-led surfaces to make component grids and docs actions easier to scan. Mermaid Use Mermaid diagrams for small flows, system relationships, and decision paths. Tree Use trees to show file structures, docs layouts, and nested implementation folders.
SDK setup
Browser, framework, identity, and event handling pieces for app-backed checkouts.
Install the SDK Load the Plandalf browser SDK on any site, app, page builder, or framework route. Configure the SDK Configure frame style, test mode, size, promos, identity, session continuity, metadata, properties, and close behavior. Identify customers Attach Plandalf checkout sessions to logged-in users with email identity or signed JWT identity. Live events Use FlowHandle events and DOM events to observe checkout starts, purchases, completions, and cancellations. Session continuity Control whether draft checkout sessions resume in a tab, across the browser, from a token, or from a fresh session. Gates Use Plandalf gates to check access before showing a checkout, upgrade, or protected product action. React SDK Use PlandalfProvider and React hooks to present offers, identify customers, check gates, and render checkout experiences.
Offers
Checkout, products, prices, coupons, bumps, upsells, save offers, and publish settings.
Offers overview Understand Plandalf Offers: hosted checkout pages, embedded checkout flows, products, prices, add-ons, order bumps, upsells, save offers, and purchase context. Create your first offer Create a checkout offer that can be hosted, embedded, tested, and connected to follow-up workflows. Templates Use offer templates to start from a proven checkout structure instead of building every page from scratch. Design your checkout Customize offer pages, blocks, themes, mobile behavior, and brand details without changing your site embed code. Products Attach products and prices to offers so checkout sessions, invoices, and integrations carry clean catalog context. Pricing models Model one-time prices, subscriptions, tiered pricing, volume pricing, trials, discounts, and promo-driven price changes. Add-ons and variants Let customers add related products, variants, upgrades, and optional line items during checkout. Multi-page flows Split longer checkouts into focused pages for plan selection, buyer details, payment, upsells, and confirmation. Add to your site Add Plandalf offers to any site with declarative attributes or programmatic SDK calls. Buy buttons Create buttons and links that open a Plandalf offer in the right frame with the right customer and promo context. Returning customers Use identity and session continuity so returning customers can resume a checkout or buy with the right account context. Hosted checkout Plandalf's hosted checkout — managed URL, theme-able down to fonts and layout, with test and preview sessions. Order bumps Add a one-click companion product inside the same checkout, then test the selected line item, invoice, taxes, coupons, webhooks, and automation context. Save offers Present a discount, plan switch, pause, or deadline-bound offer when a subscriber starts a cancellation path.
Timers and promos
Deadlines, promo windows, countdowns, CTA links, and campaign state.
Timers and promos overview Use Plandalf timers and promos to coordinate deadline campaigns across pages, emails, CTA links, and checkout prices. Countdown timers Embed countdown timers on pages and in email while keeping the timer connected to the campaign state. Create a promo Create a deadline promo that can drive countdowns, active tiers, redirect targets, and checkout price changes. Tiers and timing Model campaign phases so each deadline window can change copy, CTA targets, and checkout prices. CTA links and redirects Use promo links and participant references so campaign CTAs send each visitor to the right destination. Embedded promos Embed a promo countdown and a Plandalf checkout on the same page so deadline state and pricing stay aligned. Hosted landing pages Use Plandalf-hosted promo pages when you want the campaign URL, deadline state, and checkout handoff in one place. Promo reporting Track promo participants, tier state, CTA clicks, checkout handoff, and paid outcomes for deadline campaigns.
Affiliates
Partner, referral, and attribution docs for offer-driven growth.
Platforms
Install paths and handoffs for site builders, payment processors, and business tools.
Platforms overview Choose the right install path for Plandalf across custom HTML, React, Next.js, Webflow, Shopify, WordPress, Stripe, and PayPal. Custom HTML Install Plandalf on any HTML page with one script tag, checkout attributes, inline mounts, and optional promo widgets. React app Install Plandalf in a React app with checkout attributes, the browser SDK, or the React provider and hooks. Next.js Use Plandalf from Next.js App Router or Pages Router with next/script, client components, identity, and checkout attributes. Webflow Add Plandalf checkouts, inline embeds, and promo countdowns to Webflow with custom code and Webflow custom attributes. Shopify Use Plandalf beside Shopify for focused offers, campaign pages, paid upgrades, deadline promos, and checkout flows outside the native cart. WordPress Add Plandalf checkout buttons, inline embeds, countdown widgets, and customer identity to WordPress pages. Stripe Connect Stripe as the payment account behind Plandalf offers, then test checkout, products, prices, and payout behavior before going live. PayPal Offer PayPal as a payment option on Plandalf checkouts alongside cards and your broader offer flow.
API
Authentication, request patterns, webhooks, endpoint references, and backend integration work.
API authentication Authenticate protected Plandalf API requests, confirm the active user, and understand which organization the API will use. SDK checkout API Understand the public checkout endpoints the Plandalf SDK calls for offer loading, session creation, session lookup, mutations, and discounts. Catalog API Read catalog products, product plans, and related product metadata from the protected Plandalf API. Webhooks Start Plandalf automations from generated catch URLs or send outbound HTTP requests from automation actions. Developer API reference Reference the main SDK methods, HTML attributes, FlowHandle events, and protected API authentication model.
Implementation references
Keep these pages open when an agent, developer, or operator needs API details, SDK setup, platform installs, webhooks, integrations, or a complete API-first stack.
API reference Endpoint reference for API-backed commerce workflows. SDK checkout Use SDK checkout when the buying surface belongs inside an app. Webhook docs Route purchase, payment, invoice, and fulfillment events downstream. Platform guides Install Plandalf on Webflow, Shopify, WordPress, React, Next.js, Stripe, and PayPal paths. Integration catalog Move from docs into app-pair implementation guides. API-first stack Use SDK checkout, API keys, payment processors, invoices, and webhooks together.
Product and platform references
When a docs task mentions Offers, Timers, Automations, Stripe, PayPal, Webflow, checkout templates, coupons, invoices, webhooks, or integrations, these are the product and platform pages to keep nearby.
Offers Hosted checkout, buy buttons, products, prices, coupons, bumps, upsells, invoices, save offers, and payment events. Timers Deadline campaigns, launch windows, email countdown GIFs, expiring coupons, and promo state. Automations Purchase-triggered workflows, sequences, CRM updates, team alerts, fulfillment, and webhooks. Stripe integration Connect Stripe while Plandalf keeps offer, checkout, payment, invoice, and purchase context. PayPal integration Add PayPal to checkout while keeping follow-up, receipts, records, and automations connected. Webflow integration Use Webflow pages with Plandalf checkout, buy buttons, embeds, SDK flows, and fulfillment handoffs.
Comparison paths for builder decisions
Docs readers often compare Plandalf with Stripe Checkout, Shopify, Kajabi, payment links, and other checkout tools before they choose an implementation path.
Plandalf vs Stripe Checkout Compare processor checkout with an offer layer for coupons, timers, bumps, invoices, and automation. Stripe Checkout alternatives Use this when docs readers are evaluating checkout tools, payment links, hosted checkout, and follow-up work. Shopify alternatives Use this when a builder needs a lighter offer and checkout layer instead of a full store platform. Kajabi alternatives Use this when a course or digital product seller needs checkout, deadlines, integrations, and purchase automation.