> ## 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. > Fluid has three navigation APIs; don't mix them up. Storefront website menus (navigation bars, footers) are /api/menus and nested menu_items, in api-reference/content-v0.yaml (API Reference: Website > Navigation menus), with a how-to in themes/navigation-menus; their list uses flat page/per_page pagination. The Fluid mobile app's navigation is /api/v2/mobile_navigations, in api-reference/mobile-v2.yaml (API Reference: Mobile app > Navigation); its list also uses page/per_page. Portal navigations belong to a portal definition (Fluid OS), in api-reference/fluid-os-v0.yaml (API Reference: Portal > Portal navigation), and each has a platform of web or mobile. > 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. # Subscriptions > Find, create and manage customer subscriptions: pause, resume, skip, cancel or reactivate them, and change variants, bill dates and payment details. Use the **Subscriptions** screen to see your customers' recurring subscriptions, start new ones and change existing ones. ## Where to find it In the admin sidebar, under **Commerce**, select **Subscriptions**. To open this screen, your role needs **View only** or **Full access** for **Subscriptions**. To create subscriptions, or to edit, pause, skip, cancel or reactivate them, it needs **Full access**. On the [Roles](/help/admin/settings/roles) screen, **Subscriptions** is in the **Commerce** card. Open the card and set access from the **Subscriptions** area's menu, not the card's. ## What's on the screen **New Subscription** and **Export** are at the top of the page. The stats bar shows **Total Subscriptions**, **Active Subscriptions**, **Average Order Value** and **Churn Rate** for the subscriptions in the list. Its date menu limits the list and the stats to subscriptions created in a period: **Today**, **Month to date**, **Year to date**, **This week**, **Last 7 days**, **30 days**, **60 days**, **90 days** or **All time**. Above the list: * The **All**, **Active**, **Paused**, **Past Due** and **Cancelled** tabs filter by status. * The search box finds subscriptions. * The sort menu orders the list by date, subscription number, status or amount. * The **Filters** panel filters by **Status**, **Last Order Date After**, **Frequency** (**Daily**, **Weekly**, **Monthly** or **Yearly**) and **Order Amount** (**Min** and **Max**). Click **Apply Filters**, or **Reset All** to clear them. The list has these columns: **Subscription #**, **Customer Name**, **Product**, **Status**, **Frequency**, **Last Order**, **Next Order** and **Amount**. **Next Order** shows the next bill date, or **Paused**, **Cancelled** or **Completed**. Click a subscription to open it. Each row's actions menu has **Edit**, which opens the subscription, and **Cancel**. To cancel several subscriptions at once, select their rows and use the table header's menu. Row actions and row selection need **Full access**. A banner above the stats bar offers a new version of the table. Click **Try it** to use it, or **Switch back** to return. In the new table, the date menu above the stats bar is gone, and **Frequency**, **Order Amount** and **Last Order After** are in its **Filters** menu. ## Create a subscription A subscription holds one product. The product picker lists only products that have a subscription plan. Click **New Subscription**. Search for the customer, or choose **Create a new customer**. The customer's **Shipping Address**, **Payment Method**, **Credit** and **Notes** cards appear on the right. The customer needs a shipping address before you can add a product, so the right prices show. Click **Edit** on the **Shipping Address**, **Payment Method** or **Notes** card to change it. To credit a rep, search for them in **Credit**. In the **Product** card, click the search field and pick a product in **Select Product**. If you pick a bundle, choose its items. In the product table, set the **Quantity**, and choose a **Plan**. The product's default plan is selected for you. The table also shows **CV**, **QV** and **Price**, and you can change the line's **CV** and **QV**. In the **Subscription Plan** card, pick a **Start Date**. It's the first bill date. It can be today or later, up to 12 months ahead, or 2 years ahead for a yearly plan. Check the **Time Zone**. It starts as your browser's time zone, and the card shows roughly when the subscription will bill. In **Order Summary**, choose a shipping method with **Add Shipping or Delivery** (**Change** once one is set), and use **Add discount** to apply a discount code. The summary shows the subtotal, shipping, tax, discount, total and the **CV** and **QV** volume. Click **Start Subscription**. The new subscription opens. **Send Invoice** emails an invoice for this subscription. A \$0 subscription doesn't need a payment method. You can also start a subscription from a customer's page; **Cancel** then takes you back to that customer. ## The subscription page The page shows the subscription's status, its **Subscription ID** and, if the last payment failed, a **Payment Failed** badge. * **Subscription Details**: the product and variant, **Unit Price**, **Plan**, **Bill Day**, **Quantity** and **Amount**. Tax and shipping are calculated when the subscription processes. * The subscription's orders, with **Order #**, **Quantity**, **Order Date** and **Amount**. * **Volume**: the subscription's **CV** and **QV**. * A timeline of notes and activity for the subscription and its orders. * On the right: **Customer**, **Shipping Address**, **Payment Method**, **Credit** (the rep who gets credit) and **Notes**. * **Discounts**: the discount codes attached to the subscription, when each expires, and any discounts included in the price. **View history** shows removed discounts. To remove a discount, click its **X** and confirm **Remove discount**. This can't be undone. The actions at the top don't appear on a completed subscription. ### Edit a subscription On **Subscription Details**, click **Edit**. Use **Update Variant** to change the variant, and change the **Quantity**. Click **Done**. To change the shipping address, payment method or notes, click **Edit** on that card on the right. To change the rep who gets credit, search in the **Credit** card. Click **Save** at the top of the page. To discard your changes, click **Revert Changes**. To change the next bill date, click **Edit** on **Subscription Details**, then click the date under **Bill Day**. In **Bill Date**, pick a date and a processing time, then click **Confirm**. The new date saves right away. Save or revert your other changes first; **Confirm** stays grayed out while you have unsaved changes. ### Pause or resume a subscription At the top of the page, click **Pause Subscription**. Choose **Pause indefinitely**, **Pause for a number of upcoming orders** (then choose how many), or **Pause until a specific date** (then pick a date after today). For the last two options, the panel shows when the customer will next be charged. Click **Pause subscription**. To restart a paused subscription, click **Resume Subscription**, pick the date to resume on, and click **Resume subscription**. ### Skip the next order Open the actions menu (**⋮**) at the top and choose **Skip Next Order**, then **Confirm**. The dialog shows the date of the order after it. To reverse the skip, choose **Undo Skip**. It's available until the date of the skipped order passes. **Skip Next Order** appears only when the subscription's plan allows skips and the skip limit isn't used up. ### Cancel a subscription Open the actions menu (**⋮**) at the top and choose **Cancel Subscription**. In the **Cancel Subscription?** dialog, click **Cancel Subscription**. ### Reactivate a cancelled subscription On a cancelled subscription, click **Reactivate Subscription**. Choose **Next Plan Billing Date**, **Activate Immediately** (charges the payment method now) or **Schedule Future Start** (then pick the year, month and day). Choose the **Shipping address**. **Summary of Changes** explains what will happen. Click **Reactivate**. ## Frequently asked questions **Active** subscriptions bill on their schedule. **Paused** subscriptions don't bill until they resume, either on a date or when you resume them. **Past Due** subscriptions have a failed payment. **Cancelled** subscriptions have stopped; you can reactivate them. Use the tabs at the top of the list to see each group. A past-due subscription shows a **Past due** banner that says whether another payment attempt is scheduled. Click **Retry** to charge the payment method now. To use a different card, click **Edit** on the **Payment Method** card, select a card or click **Add new payment method**, click **Confirm**, then click **Save**. If a subscription shows a **Payment Failed** notice instead, click **Update Payment** and update the payment method the same way. Click **Edit** on the **Notes** card, write the note in the **Add Notes** panel, click **Done**, then click **Save** at the top of the page. Click **Export**. Choose the **Countries**, **Status**, **Timezone**, **Start Date** and **End Date**, then click **Export**. By default the export covers active subscriptions in every country over the last 30 days. The CSV file downloads, or a message says the export has started. Your role can view subscriptions but doesn't have **Full access** for **Subscriptions**. Ask an admin who manages roles to update your role. See [Roles](/help/admin/settings/roles). ## Related pages * [Commerce](/help/admin/commerce) * [Orders](/help/admin/orders) * [Subscription Plans](/help/admin/settings/subscription-plans) * [Promo Codes](/help/admin/promo-codes) * [Roles](/help/admin/settings/roles) * [We-Commerce concepts](/concepts/we-commerce) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.