> ## Documentation Index > Fetch the complete documentation index at: https://docs.fluid.app/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > For new direct REST integrations, use the v2026-04 surfaces. The @fluid-app FairShare SDK continues to use its own published public-v2025-06 contract. > Authenticate with the header Authorization: Bearer ; public storefront read endpoints require no auth. > To sign a new merchant up for Fluid programmatically, call POST https://api.fluid.app/api/company with no credentials, as described in /api/agent-signup. Do not automate the signup form or book a demo. The merchant must open the emailed sign-in link and create an API token before authenticated calls are possible. > Lists use cursor pagination via the page[cursor] and page[limit] query params; follow meta.pagination.next_cursor until it is null. > When the same operation exists on more than one surface, use the newest: dated API versions are newer than unversioned ones, and later dates win (v2026-04 > v2025-06 > unversioned v0/v1.1). Fall back to a legacy or unversioned operation only when no newer versioned equivalent exists — the company-v0 notes below list the known superseded operations. /api/company/v1 and /api/v1/... paths are documented in no spec here and must never be used (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > Navigation menu management is documented in themes/navigation-menus. These unversioned admin endpoints (/api/menus and nested menu_items) are verified against the implementation but are not yet in the synced OpenAPI specs. Use that reference for menu payloads and its flat page/per_page pagination; missing spec coverage does not make these endpoints unavailable. > The OpenAPI specs under api-reference/ are the authoritative contracts; prefer them over prose when in doubt. api-reference/storefront-v2026-04.yaml covers the v2026-04 storefront surface (/api/v202604/... paths); api-reference/checkout-v2026-04.yaml covers the v2026-04 checkout surface (/api/checkout/v2026-04/... paths — carts, cart auth, discounts, items, subscriptions, orders, enrollments, and store config); api-reference/public-v2025-06.yaml covers the Public SDK surface used by the @fluid-app FairShare SDK, including its parallel cart lifecycle, browser integrations, versioned payment callbacks, unversioned public utilities, and the cart price-override operation; api-reference/payment-v2026-04.yaml covers the v2026-04 payment gateway admin surface (/api/payment/v2026-04/... paths, bearer-authenticated — gateway CRUD, gateway purchase/authorize/$0-verify, transaction list/show and capture/void/credit, and merchant payment configuration); api-reference/payments-v2026-04.yaml covers the v2026-04 cart payment surface (/api/payments/v2026-04/carts/{cart_token}/... paths, authenticated by the cart token in the path with no bearer — payment-method selection, VGS card tokenization, 3D Secure verification, and PayPal/Braintree/Klarna/Apple Pay flows); api-reference/commerce-v2026-04.yaml covers the v2026-04 commerce order-editing surface (/api/v202604/orders/{order_id}/edits paths, bearer-authenticated — post-checkout order edits that atomically insert items and add adjustments/discounts, with an optional dry-run preview); api-reference/webhooks-v0.yaml covers the unversioned webhooks surface (/api/... paths — webhook registration, delivery payloads, callback registrations, company events, and webhook/callback schemas); api-reference/company-v0.yaml covers the legacy unversioned company admin surface (/api/... paths, bearer-authenticated — company settings and management, customers, users, roles, subscription plans, subscription bundles, subscriptions, media, pages, catch-ups, inventory levels, domains, agreements, and admin order actions). company-v0 caveats: it is the legacy v0 admin contract and its lists use flat page/per_page offset pagination, which is expected there despite the general cursor-pagination rule; where an operation exists in both company-v0 and a versioned spec, prefer the versioned spec — the subscriptions lifecycle (list/create/show/update, cancel, pause, reactivate, resume, retry, skip, failed-cycle-waiver, discounts) and subscription bundles are superseded by checkout-v2026-04, and company pages/media CRUD plus the public pages, categories, products, and media list endpoints are superseded by storefront-v2026-04. Subscription plan management (/api/subscription_plans, resource-wrapped {"subscription_plan": {...}} bodies) exists only in company-v0. api-reference/members-v2025-06.yaml covers the v2025-06 unified Member identity surface (/api/v2025-06/members/... paths, bearer-authenticated — member list/create/show/update, lookup by email/username/external_id/legacy_customer_id, member-type assignment, and the sponsor genealogy read). Prefer it over the customers and reps surfaces when the member type matters: /customers does not serialize member_type. api-reference/analytics-v2026-04.yaml covers the v2026-04 Home dashboard analytics surface (/api/v202604/analytics/dashboard/... paths, bearer-authenticated — read-only endpoints for the Home > Overview, Home > Live, and Home > Field tabs, each accepting an optional country ISO alpha-2 query param that scopes aggregations to a single country). > api-reference/analytics-v0.yaml covers the unversioned analytics surface that backs the fluid-admin Traffic tab (/api/analytics/... and /api/analytics/traffic/... paths, bearer-authenticated — the legacy shares/views/visitors summary plus traffic overview, ranked campaigns, sources, geographies, flows, and per-rep breakdown, all sharing one reporting-period contract). > Successful responses wrap the resource payload alongside a top-level integer status and a meta object. > Portal Definition authoring edits and synchronizes the portal JSON resource graph. Widget Package authoring builds either a company-owned or Droplet-owned Remote DOM package. These are separate contracts; do not imply that one defines the other. > For Widget Package worker code, use only @fluid-app/portal-sdk/widgets/worker. Use only the Portal Definition and Widget Package workflows and public entry points documented here; do not infer support for undocumented surfaces. > Every portal function and declarative capability used by a widget must appear in that widget's uses array. Use the same typed function value in uses; do not invent capability-name strings. > Widget styling must use the portal's semantic theme variables for colors, typography, spacing, radii, borders, focus, and charts whenever a token represents the visual decision. Do not create a separate light or dark palette or duplicate theme controls as widget properties. > Prefer worker-safe Fluid UI components exported by @fluid-app/portal-sdk/widgets/worker when they fit the interaction. When no exported component fits, use semantic HTML, accessible behavior, and the portal theme variables. > A Portal Definition push updates the remote working definition. A portal version is an immutable snapshot, and activation is a separate live release operation. # Checkout > Set your checkout's button color and choose whether it collects phone numbers, shows marketing opt-ins or lets reps pick who gets order credit. The Checkout screen controls how your checkout looks to customers and what its form asks them for. ## Where to find it In the admin, click the **Settings** gear in the top bar. In the Settings sidebar, under **Commerce**, select **Checkout**. To see **Checkout** in the sidebar and open the screen, your role needs the **Access order settings and configuration (Checkout, Shipping, Taxes)** switch under **Orders**. To load your checkout settings, it also needs the **Company Settings** switch that starts with **View global company configuration**. Without it, the screen shows default values, such as a black button color and every toggle off, instead of your saved settings, so don't save from it. To save changes, your role also needs the **Company Settings** switch that starts with **Edit company-wide settings**. Those two **Company Settings** switches don't mention Checkout, but this screen uses them. See [Roles](/help/admin/settings/roles). ## What's on the screen The header at the top holds the **Save** button. Below it, a banner has a **Setup payment methods** button that opens [APM](/help/admin/settings/apm), where you manage alternative payment accounts. Below the banner are the **Preview** and two collapsible sections, **Styling** and **Checkout Form**. On a wide screen, the preview sits on the left and the sections on the right. Both sections start closed, and only one opens at a time. Your changes show in the preview right away, but they take effect only when you click **Save**. ### Preview The preview is a sample checkout that updates as you change settings. It shows: * Your company logo, which is the **Primary Logo** from [Brand Guidelines](/help/admin/settings/brand-guidelines). Without one, a placeholder with your subdomain appears. * One of your active products, with its image, name and price. Without an active product, a placeholder product appears. * A **Discount Code** field with an **Apply** button. * **Subtotal**, **Taxes**, **Shipping** and **Total** lines. Taxes and shipping are sample amounts. * A **Contact** section with **Name** and **Email** fields, plus **Phone** when **Collect phone number** is on. * The email and SMS marketing checkboxes, when **Collect email marketing** or **Collect SMS marketing** is on. * A **Pay now** button. ### Styling **Primary Button Color** sets the color of your checkout's main buttons. You don't pick a text color. The button text turns black on light colors and white on dark colors. ### Checkout Form This section has five toggles: * **Collect phone number**: adds a phone number field to guest checkout. * **Require phone number**: makes that field mandatory. Checkout asks signed-in customers without a valid phone number on file to add one. * **Order on behalf**: when a rep is signed in and checking out their own cart, checkout shows an **Order credit** section where they choose which rep gets credit for the order. * **Collect email marketing**: shows an **Email me with news and offers** checkbox at checkout. * **Collect SMS marketing**: shows a **Text me with news and offers** checkbox at checkout. ## Tasks ### Change the button color Click **Styling** to expand it. Under **Primary Button Color**, click the swatch and choose a color. You can also type a six-digit hex value, such as `#2E6DB4`, in the field next to it. The **Apply** and **Pay now** buttons in the preview change color. Click **Save**. A **Checkout settings saved successfully** message appears. ### Require a phone number Click **Checkout Form** to expand it. Turn on **Collect phone number**. A **Phone** field appears in the preview. Turn on **Require phone number**. Click **Save**. ### Add marketing checkboxes Click **Checkout Form** to expand it. Turn on **Collect email marketing**, **Collect SMS marketing** or both. The matching checkboxes appear in the preview. Click **Save**. ## FAQ **Save** is unavailable when nothing has changed, including after you change a setting back to its saved value. It's also unavailable while the screen is loading or saving. If a **Failed to update checkout settings** message appears when you save, Fluid didn't save your changes. If it keeps failing, check that your role has the permissions listed under [Where to find it](#where-to-find-it). **Require phone number** needs **Collect phone number** turned on first. Until then, the toggle is unavailable and its description reads **You must enable 'Collect phone number' first**. Turning off **Collect phone number** also turns off **Require phone number**. ## Related pages * [Settings](/help/admin/settings) * [Agreements](/help/admin/settings/agreements) * [APM](/help/admin/settings/apm) * [Brand Guidelines](/help/admin/settings/brand-guidelines) * [Roles](/help/admin/settings/roles) * [Shipping](/help/admin/settings/shipping) * [Taxes](/help/admin/settings/taxes)