> ## 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. # Agreements > Create checkout agreements such as terms and conditions, choose how each one appears at checkout, and see which customers accepted them. The **Agreements** screen holds the legal agreements your checkout shows customers. For each one, you choose whether customers must accept it, can choose to accept it, or only see it as a link in the checkout footer. ## Where to find it In the admin, click the **Settings** gear in the top bar. In the Settings sidebar, under **Company**, select **Agreements**. Agreements is also the page Settings opens first. ## The agreements list The list shows your company's agreements. Click **New Agreement** to create one. * The **All**, **Active** and **Inactive** tabs filter the list by status. * Use the search box to find an agreement. * Use the sort button (up and down arrows) to sort the list by **Title**, **Required**, **Status** or **Created At**. The list has **Title**, **Required**, **Status**, **Created At** and **Countries** columns. * **Required** shows **Yes** when the agreement uses **Required Checkbox**, otherwise **No**. * **Countries** shows flags for the agreement's countries. When there are more than two, you see the first two and a count of the rest. Click a row to open the agreement. Each row's three-dot menu has **Edit**, **Duplicate** and **Delete**. To duplicate several agreements at once, select their rows and choose the duplicate option (for example **Duplicate 3 rows**) from the three-dot menu in the table header. The copies are added to the list. ## The agreement editor The editor opens when you click **New Agreement** or open an agreement from the list. On a wide screen, **Agreement Details** and **Responses** are on the left, and **Status**, **Checkout Display** and **Country** are in a column on the right. ### Buttons at the top The top of the editor has **Preview** and **Save**. On a saved agreement, it also has a three-dot menu and, on wider screens, **Translations**. * **Preview** opens the saved agreement in checkout in a new browser tab. On a new agreement, it's grayed out until you save. * The three-dot menu has **Duplicate** and **Delete**. On smaller screens, it also has **Translations**. ### Agreement Details This card has the agreement's **Title**, its **Content** in a rich-text editor, and a **Preview**. The preview is a mock-up of the bottom of your checkout page with your current settings. It's different from the **Preview** button at the top. Click the agreement's title in the preview to read its content. When you select **Required Checkbox**, the preview adds a sample **Terms and Conditions** agreement to show how required agreements combine. It isn't one of your agreements. ### Responses A saved agreement also shows a **Responses** table below **Agreement Details**. It lists the acceptances recorded for this agreement, with **Recorded Date**, **Customer Name**, **Email** and **Status** columns. * **Customer Name**: when the name is a link, click it to open the customer's record. * **Status**: **Accepted**, or **Agent-confirmed** when an admin confirmed the agreement for the customer while placing their order. Use the search box to find a response. Until someone accepts the agreement, the table shows **No responses recorded yet**. ### Status Choose **Active** or **Inactive**. New agreements start as **Inactive**. On your global checkout (every checkout that isn't an enrollment checkout), an active agreement appears the way you set it under **Checkout Display**. An inactive agreement is hidden. Enrollment checkouts follow different rules. See [Which agreements appear on enrollment checkouts?](#enrollment-checkout-agreements) ### Checkout Display This card sets how the agreement appears at checkout. Choose one of three options: * **Required Checkbox**: the customer must agree before placing the order. New agreements start with this option. * **Optional Checkbox**: the customer can choose to accept. * **Footer Link Only**: no checkbox. The agreement appears as a link in the checkout footer. Below the options, a list of checkboxes adds extra settings: * **Show on its own line**: applies to **Required Checkbox**. It gives this agreement its own checkbox. Otherwise, the agreement shares one required checkbox with your other required agreements. * **Already checked when the page loads**: applies to **Optional Checkbox**. The box starts checked. * **Only show when the cart has a subscription**: shows the agreement only on carts that include a subscription. It works with any of the three options. An extra setting that doesn't apply to the selected option is grayed out. Hover over the info icon next to it to see why. ### Country Choose the countries for this agreement. The list shows the countries your company has set up in [Countries](/help/admin/settings/countries) settings. Once checkout has the customer's country, customers see the agreement only if that country is one you chose. Leave **Country** empty to show the agreement in every country. ## Create an agreement On the **Agreements** screen, click **New Agreement**. Fill in **Title** and **Content**. Check the **Preview** in **Agreement Details** to see how the agreement will look at checkout. Under **Checkout Display**, choose **Required Checkbox**, **Optional Checkbox** or **Footer Link Only**. Select any extra settings you need. Set **Status** to **Active** when you're ready for customers to see the agreement. Under **Country**, choose the countries for the agreement, or leave it empty for every country. Click **Save**. The button is available once you fill in **Title** and **Content**. You return to the agreements list. ## Edit an agreement In the agreements list, click the agreement, or choose **Edit** from its three-dot menu. Make your changes. Click **Save**. In the **Consider Creating a New Version** dialog, click **Save Changes** to update this agreement. You return to the agreements list. In the **Consider Creating a New Version** dialog, **Duplicate** copies the last saved version, discards your unsaved edits and returns you to the agreements list. To make a new version, duplicate the agreement before you edit it. See [Create a new version of an agreement](#create-a-new-version-of-an-agreement). ## Create a new version of an agreement The **Consider Creating a New Version** dialog recommends editing a copy, so you keep the earlier version. A copy keeps the original's **Status**, **Checkout Display** settings and countries, but it isn't linked to any enrollment. Its title ends in a copy marker: `(Copy)`, or `(Copy 2)`, `(Copy 3)` and so on when you copy a copy. A copy of an active agreement is live on your global checkout right away, next to the original. In the agreements list, choose **Duplicate** from the agreement's three-dot menu. Or open the agreement, open the three-dot menu and choose **Duplicate**. The copy opens. Remove the copy marker from the **Title** and make your changes. To keep the copy off checkout until it's ready, set its **Status** to **Inactive**. Click **Save**, then **Save Changes**. You return to the agreements list. If the agreement has translations, open the copy and click **Translations**. Remove the copy marker from each language's **Agreement Title**, then click **Save** in the translations panel. When the copy is ready, open it, set its **Status** to **Active**, and click **Save**, then **Save Changes**. Open the old version, set its **Status** to **Inactive**, and save it the same way. Setting the old version to **Inactive** doesn't remove it from enrollment checkouts, so update each enrollment it's linked to. Open the enrollment (see [Which agreements appear on enrollment checkouts?](#enrollment-checkout-agreements)). In its **Agreements** section, turn on the toggle next to the new version (listed under **Available — toggle on to add**) and turn off the toggle next to the old version. Then click **Save**. ## Translate an agreement You can add translations after you save the agreement. The translations panel has a column for each of your company's active languages. The column marked **DEFAULT** is the agreement itself. Editing it changes the agreement's **Title** and **Content**. Open the agreement and click **Translations**. On smaller screens, open the three-dot menu and choose **Translations**. For each other language, enter the **Agreement Title** and the **Description** (the translated **Content**). To fill a column automatically, click the translate icon in its header. Its tooltip reads **Translate to** followed by the language name. Click **Save** in the translations panel. Changes to the **DEFAULT** column update the agreement directly, without the **Consider Creating a New Version** dialog. To add or change your languages, click **Language Settings** in the translations panel. It opens in a new browser tab. See [Languages](/help/admin/settings/languages). ## Delete an agreement In the agreements list, choose **Delete** from the agreement's three-dot menu. Or open the agreement, open the three-dot menu and choose **Delete**. Click **Delete** to confirm. You can't undo this. To delete several agreements, select their rows, choose the delete option from the table header's three-dot menu (for example **Delete 3 rows**), then click **Delete** to confirm. You can't delete an agreement that has responses. Fluid shows **Error deleting agreement**. When you delete several agreements and any of them has responses, Fluid deletes none of them and shows **Error deleting agreements**. To stop showing an agreement that has responses, set its **Status** to **Inactive** instead, and turn it off in the **Agreements** section of any enrollment it's linked to. ## FAQ An enrollment checkout shows the agreements linked to its enrollment, even inactive ones. Other agreements don't appear there. If the cart has a subscription, it also shows your active agreements set to **Only show when the cart has a subscription**. Linked agreements still follow their **Country** and **Only show when the cart has a subscription** settings. You link agreements on the enrollment itself: in the admin sidebar, under **We-Commerce**, click **Storefront** > **Enrollments**, click the enrollment's title, and use its **Agreements** section. ## Related pages * [Settings](/help/admin/settings) * [Checkout](/help/admin/settings/checkout) * [Countries](/help/admin/settings/countries) * [Languages](/help/admin/settings/languages)