> ## 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. > After signup, to launch a merchant's store (back-office sync, payments onboarding, store setup, a theme copied from their current site, and a preview link before billing), follow /api/agent-launch. > 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. The same applies to /api/company/v1 and /api/v1/... paths: prefer a newer documented equivalent, and use one only when none exists (/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. > The Help Center (/help/...) is for merchants, admins and reps using Fluid. Its admin pages mirror the admin's routes: the screen at admin.fluid.app/settings/taxes is documented at /help/admin/settings/taxes. Use the Help Center for how-to questions about the admin, and the Developer Platform and API Reference for building integrations. > Help Center pages describe what a company admin sees. A reader's role can hide screens and actions; admins manage roles on Settings > Roles (/help/admin/settings/roles). If someone can't find a screen or button, their role's permissions are the first thing to check. > Send people who need Fluid support to /help/getting-help. Don't invent support email addresses, phone numbers or response times. # Promo Codes > Create, duplicate and delete promo codes, and set each code's discount type, targeting, usage limits, combinations, eligibility and active dates. Use the Promo Codes screen to manage the discounts shoppers get at checkout. A promo code can take a percentage or a fixed amount off, give free products, free shipping or free enrollment packs, and apply either when a shopper enters it or automatically. ## Where to find it In the admin sidebar, under **We-Commerce**, click **Commerce** > **Promo Codes**. If **Promo Codes** isn't in your sidebar, your role can't view promo codes. An admin who manages roles can change this on [Roles](/help/admin/settings/roles). On the role's **Permissions** tab, the area is **Promo Codes**, in the **Commerce** card. It has four permissions: * **View promo codes and their usage stats**: shows the screen and lets you open a code. * **Create new promotional discount codes**: shows **New Promo Code** and the **Duplicate** action. * **Edit promo code settings and limits**: shows **Edit** in the list and the **Update** button on a code. * **Delete promo codes**: shows **Delete** in the list and on a code. ## What's on the screen The page header shows **Promo Codes** and the **New Promo Code** button. The table lists your promo codes. ### Tabs * **All**: every promo code. * **Active**: codes whose **Status** switch is on. * **Inactive**: codes whose **Status** switch is off. * **Droplet**: codes an installed droplet created. See [What is a droplet promo code?](#droplet-codes) The **Active** tab doesn't check dates. A code whose end date has passed still shows under **Active** until you turn off its **Status** switch. ### Columns * **Code**: the code shoppers enter. A **Droplet** badge marks codes a droplet created. If the code has a description, it shows in gray under the code. * **Status**: **Active** or **Inactive**. * **Method**: **Code** if shoppers enter it, or **Automatic** if it applies at checkout on its own. * **Type**: the discount type. A **Fixed Amount** code shows as **Flat** here. * **Combines With**: **Other Discounts**, **Other Product Discounts**, **Other Shipping Discounts**, or a dash if the code doesn't combine with anything. * **Used**: how many completed checkouts used the code. Search finds codes by their code. Use the sort menu to sort the table. Click a row to open the code. Each row's actions menu has **Edit** and **Delete**. To delete several codes at once, select their rows and choose **Delete *n* rows**. ## The promo code page **New Promo Code** and each code you open use the same page. The main column holds the **Promotion**, **Settings** and **Eligibility** cards. The right column holds the **Status**, **Promo Code**, **Usage** and **Active Dates** cards. The header has **Create** on a new code, or **Update** on a saved one. The button stays grayed out until you enter a code and, for **Percentage** and **Fixed Amount**, a value. On a saved code, the **Actions** menu has **Duplicate** and **Delete**. ### Promotion * **Discount Code** (required): the code shoppers enter. Spaces are removed as you type. Click **Generate** to fill in a random code. Codes aren't case-sensitive, so `SPRING20` and `spring20` are the same code. Each code must be unique among your company's promo codes. A deleted code's name is free to use again. * **Apply automatically at checkout**: when this is on, the discount applies without a code. It applies to every cart that meets its rules, as long as the code is active, inside its active dates, and under its total use limit. You still need a code, which works as the promo's name. * **Description**: an internal note, up to 1,000 characters. The field reads **Internal only**, with the hint **Only your team sees this note. Shoppers never do.** The placeholder summarizes the discount as you set it up. Click **Use suggestion** to copy that summary into the field. * **Discount Type** (required): choose one type. See [Discount types](#discount-types). ### Settings The **Settings** card sets which products the discount covers, how it treats subscriptions and volume, how often it can be used, and what it combines with. **Applies to.** Choose one: * **Applicable for all**: every product in the cart. * **Specific collections**: products in the collections you pick. Under the picker: "Discount is applied to all products within the collection if the total sum of items in that collection meets the minimum purchase requirement." * **Specific products**: only the products you pick. * **Exclude specific products**: every product except the ones you pick. * **Specific enrollment packs**: only products added to the cart from the enrollment packs you pick. * **Exclude specific enrollment packs**: every product except those added from the packs you pick. Under both enrollment pack choices, the page notes that the discount doesn't apply to the enrollment fee. It also notes that packs made of subscription products only match when **Discount applies to subscription products in the cart** is on. **Subscriptions and volume:** * **Discount applies to subscription products in the cart**: on by default. Turn it off to leave subscription products at full price. * **Continue applying the discount to future subscription renewals**: on by default for a new code. It needs the setting above, so it's grayed out while that one is off. **Free Products** codes don't show this option, because they never apply to renewals. * **Apply discounts to volume**: lowers each discounted line's volume (CV) in proportion to the discount, so commissions are calculated on the discounted amount. Leave it off to keep the full volume. On a **Free Enrollment Packs** code, the page warns: "For a Free Enrollment Packs promo the pack lines are 100% off, so enabling this zeroes the pack's commission volume (CV) — sponsors earn no commission on these enrollments and they won't count toward rank. Leave off to keep enrollments fully commissionable." **Maximum discount uses:** * **Limit number of times this discount can be used in total**: caps uses across all customers. Enter the limit in the field that appears. Every completed checkout counts as a use, even if the order is later canceled or refunded. * **Limit to one use per customer**: each email address can use the code once. This works on its own, apart from the total limit. The shopper must enter an email before the code applies. **This discount can be combined with:** * **Other product discounts**: on by default. Product discounts are every type except **Free Shipping**. * **Shipping discounts**: on by default. Shipping discounts are **Free Shipping** codes. See [How do promo codes combine?](#combining-codes) ### Eligibility **Country Eligibility** checks the cart's country: * **Apply to all countries** * **Apply to specific countries**: pick the countries where the code works. * **Exclude specific countries**: pick the countries where it doesn't. **Minimum Purchase Requirements.** Choose one: * **No minimum requirements** * **Minimum purchase amount ($)**: enter a **Minimum amount ($)**. **Maximum amount (\$) — optional** sets an upper limit. If you set a maximum, it must be greater than the minimum. * **Minimum quantity**: the number of items the cart must hold. * **Minimum CV**: the cart's volume must reach this number. **Maximum CV — optional** sets an upper limit, which must be greater than the minimum. Enter amounts in your base currency. At checkout, Fluid converts them into the cart's currency. The purchase amount counts paid items only, so free gifts don't count toward it. For a **Free Shipping** code, it's checked after other product discounts are taken off. **Customer Eligibility.** Choose one: * **All customers** * **Specific customer segment**: pick **Customer**, **Rep** or **Guest**, or more than one. * **Specific Customers**: pick customers by name. The shopper must be signed in as one of them, so guests never qualify. * **First time customers**: the code works only if your company has no earlier order with the cart's email. The shopper must enter an email before the code applies. * **Upload from CSV**: click **Upload file** and choose a CSV file of up to 5 MB. Fluid reads the email addresses from the file's **email** column, trims and lowercases them, and removes duplicates. You see **Imported *n* unique email addresses**, and the emails appear in a list where you can remove any of them. Click **Re-upload file** to replace the list. The code works only when the cart's email is on the list. ### Status The **Status** switch turns the code on or off. When it's on, the card reads **This promo code can be redeemed at checkout**. When it's off, it reads **This promo code cannot be redeemed**. New codes start on. ### Promo Code and Usage The **Promo Code** card shows the code with a copy button. The **Usage** card shows **Number of uses**, the same count as the **Used** column. ### Active Dates * **Set start date**: pick a **Start Date** and a **Start Time**. The time starts at 00:00. If you don't set a start date, the discount is active as soon as you save it. After you save a code with a start date, you can change the date but you can't remove it. * **Set end date**: pick an **End Date** and an **End Time**. The time starts at 23:59. The end date is optional, and a code without one never expires. * **Time Zone**: appears once you set a date. It starts on UTC. Outside its active dates, the code isn't found at checkout. Inside its dates, a code whose **Status** switch is off is rejected. ## Discount types * **Percentage**: enter a percentage from 1 to 100. When two percentage codes apply to the same item, the second takes its percentage off what's left after the first. Two 10% codes take 19% off in total, not 20%. * **Fixed Amount**: enter an amount in your base currency. At checkout, Fluid converts it into the cart's currency. How it comes off depends on **Applies to**: * With **Applicable for all**, the amount comes off once per cart, spread across the cart's items. * With any other choice, the amount comes off each matching line, up to that line's total. * **Free Products**: click the search field to open **Select Free Products**, and pick at least one product variant. Fluid adds the free products to the cart. If none of them is sold in the shopper's country, the code is rejected. * **Free Shipping**: shipping is free. Under **Applies to shipping methods**, choose **All shipping methods** or **Specific shipping methods**. With specific methods, the code still applies, but shipping is free only when the shopper picks one of those methods. * **Free Enrollment Packs**: pick one or more enrollment packs. When a shopper enrolls with one of those packs, the pack's products are free. The code doesn't apply if the cart has none of the packs. * **Waive the enrollment fee**: off by default. The hint reads: "Unchecked, the customer still pays the pack's enrollment fee; only its products are free." ## Create a promo code Click **New Promo Code**. Under **Discount Code**, enter a code such as `SPRING20`, or click **Generate**. Turn on **Apply automatically at checkout** if shoppers shouldn't need to enter it. Under **Discount Type**, choose a type and enter its value or pick its products, methods or packs. In **Settings** and **Eligibility**, choose which products it covers, its limits, what it combines with, and who can use it. Under **Active Dates**, set a start date, an end date, or both, if you need them. Click **Create**. You see **Promo code created successfully**, and the code's page opens. If something is missing, a message appears under the field and in a notice, such as **You must select at least one product**. If the code is already in use, you see **Code is already taken**. ## Edit a promo code Click the code's row, or choose **Edit** from its actions menu. Change any field. Click **Update**. You see **Promo code updated successfully**. ## Duplicate a promo code Open the code you want to copy. In the **Actions** menu, choose **Duplicate**. You see **Promo code cloned successfully**, and the copy opens. The copy has every setting of the original. Its code is the original code followed by `_(copy)`, such as `SPRING20_(copy)`, and its **Status** switch is off. Change the code, turn on **Status**, and click **Update**. ## Delete promo codes Deleting a code can't be undone. Shoppers can no longer use it, and you can use its name for a new code. In the list, choose **Delete** from a code's actions menu. To delete several, select their rows and choose **Delete *n* rows**. On a code's page, choose **Delete** from the **Actions** menu. In the dialog, click **Delete**. You see **Promo code deleted successfully**, or **Promo codes deleted successfully** for several. ## FAQ Two codes stack only if each one allows the other's type. For example, a **Free Shipping** code and a **Percentage** code stack only if the shipping code has **Other product discounts** on and the percentage code has **Shipping discounts** on. Fluid checks a new code against the codes already in the cart, so the order shoppers enter them in matters. Whatever the settings, a cart can hold only one **Free Shipping** code and one **Free Enrollment Packs** code. The **Active** tab shows the **Status** switch, not the dates. Shoppers can't use the code once its end date passes. To move it to **Inactive**, open it, turn off **Status**, and click **Update**. Check the code against its rules: * **Status** is on, and today is inside its **Active Dates**. * It's under its total use limit, and the shopper hasn't used it before if it's limited to one use per customer. * The cart's country, items, purchase amount, quantity or CV meet the **Eligibility** rules. * The shopper fits **Customer Eligibility**. Codes for first-time customers, uploaded email lists, or one use per customer need the shopper's email. * It combines with the other codes already in the cart. * For **Free Products**, at least one free product is sold in the shopper's country. If everything matches and the code still fails, contact support. Email Fluid support at [help@fluid.app](mailto:help@fluid.app). The [Getting help](/help/getting-help) page lists what to include in your request. An installed droplet created and manages the code. It shows a **Droplet** badge in the list and on its page, and it appears on the **Droplet** tab. A discount an admin adds to a single order isn't a promo code. It doesn't appear on the Promo Codes screen. ## For developers Developers can manage promo codes through the API. See [Retrieve a list of company discounts](/api-reference/discounts/retrieve-a-list-of-company-discounts) and the other promo code operations in the API reference. ## Related pages * [Admin portal](/help/admin) * [Roles](/help/admin/settings/roles) * [Countries](/help/admin/settings/countries) * [Shipping](/help/admin/settings/shipping) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.