> ## 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. # Subscription Plans > Create subscription plans, set their billing and shipping schedules and discounts, and choose your company's default plan. Use the **Subscription Plans** screen to create and manage your company's subscription plans. You can also turn on subscription bundling for your whole company here. ## Where to find it In the admin, click the **Settings** gear in the top bar. In the Settings sidebar, under **Commerce**, select **Subscription Plans**. To open this screen, your role needs **View only** or **Full access** for **Subscription Plans**. To create, edit or delete plans, or change their status, it needs **Full access**. On the [Roles](/help/admin/settings/roles) screen, **Subscription Plans** is in the **Commerce** card. Open the card and set access from the **Subscription Plans** area's menu, not the card's. ## What's on the screen The **New Subscription Plan** button is at the top of the page. Further down are the **Bundle subscriptions automatically** card and then the list of plans. ### Bundle subscriptions automatically This switch applies to your whole company. When it's on, Fluid combines a customer's subscriptions that bill on the same date and ship to the same address into one order. Clicking the switch saves the setting right away. To change it, your role needs **Full access** for both **Subscription Plans** and **Companies**. On the [Roles](/help/admin/settings/roles) screen, **Companies** is in the **Settings** card; set it from the **Companies** area's menu, not the card's. If a **Failed to update bundle subscriptions setting** message appears and the switch turns back, check your role's access to **Companies**. ### Plans list * The **All**, **Active** and **Inactive** tabs filter the list by status. * Use the search box to find a plan by name. The list has these columns: * **Plan Name**: the plan's name. Your company's default plan has a **Company Default** badge. * **Billing Frequency**: how often the plan bills, for example **1 Month** or **3 Months**. * **Discount**: the plan's percentage discount, such as **10%**, or **Per Variant** when the plan's pricing is defined on each product. * **Associated Products**: how many products the plan is linked to. The count includes products where you've turned the plan off in the product's **Manage Subscription Plans** panel. * **Subscribers**: how many subscriptions use the plan. The count includes cancelled subscriptions. * **Status**: **Active** or **Inactive**. Click a plan to open it. Each row's actions menu has **Delete** and **Toggle Status**. The table header has the same menu for the rows you select, labeled with the count, such as **Delete 3 rows**. ### Plan page The plan page opens when you click **New Subscription Plan** or a plan in the list. A new plan's page is titled **New Subscription Plan**. A saved plan's page shows the plan's name. Badges next to the title show: * **Active** or **Inactive**, matching the **Status** field. * **Company Default**, when the **Company Default** switch is on. * **Unsaved Changes**, when you've changed something you haven't saved. On a new plan, **Create** is at the top of the page. On a saved plan, **Delete** and **Save Changes** are there instead. **Save Changes** reads **Saved** when there's nothing to save. The main card holds the plan's schedule and pricing: * **Subscription Plan Name**: required. * **Billing Interval**: how often the subscription is billed. Choose a number, **Every 29** or less, and a unit (**Day**, **Week**, **Month** or **Year**). A new plan starts at 1 month. * **Fulfillment Frequency**: how often the products in the subscription are shipped. It has the same choices as **Billing Interval** and also starts at 1 month. * **Volume Frequency**: how often the products' volume credit (CV/QV) for commissions is assigned. It has the same choices and also starts at 1 month. * **Pricing Strategy**: how the discount is calculated. * **Percent Off** applies one percentage to all variants. Enter the percentage, from 0 to 100, in the field next to it. A new plan starts at **Percent Off** with no discount. * **Defined on product** uses each variant's own subscription price, which you set in the product details. The percentage field is grayed out. * **Show Savings As**: how the savings appear to customers on shop pages, product detail, cart and checkout. Choose **Percent off (Save 10%)** or **Dollar amount (Save \$5.00)**. A new plan starts at **Percent off (Save 10%)**. * **Apply Discount To Volume**: a switch, off by default. When it's on, Fluid reduces each subscribed line's CV/QV by the same percentage as the plan's price discount. Existing subscriptions pick up the change on their next renewal. Past orders don't change. The cards on the right: * **Status**: **Active** or **Inactive**. A new plan starts as **Active**. * **Company Default**: a switch that sets this plan as the default subscription plan for your company. Only an active plan can be the default. * **Allow Skips**: a switch, off by default. When it's on, choose **Max Skips Allowed**, from 1 to 10. * **Max Billing Cycles**: a switch, off by default, that sets a maximum number of billing cycles for the plan. When it's on, choose the number of cycles, from 1 to 100. * **Stats**: the plan's **Subscribers** and **Associated Products** counts. They're counted the same way as the matching columns in the plans list. ## Tasks ### Create a plan On the **Subscription Plans** screen, click **New Subscription Plan**. Enter a **Subscription Plan Name**. Choose the **Billing Interval**, **Fulfillment Frequency** and **Volume Frequency**. Choose a **Pricing Strategy**. For **Percent Off**, enter the percentage. Then choose how to **Show Savings As**, and turn on **Apply Discount To Volume** if you want it. Set the **Status**. Turn on **Company Default**, **Allow Skips** or **Max Billing Cycles** if you need them. For each of **Allow Skips** and **Max Billing Cycles** that you turn on, choose a number. Click **Create**. A confirmation message appears and you return to the plans list. To offer the plan on a product, associate it from the product's page. See [How do I offer a plan on a product?](#add-plan-to-product). ### Edit a plan In the plans list, click the plan. Change the fields you need. The **Unsaved Changes** badge appears. Click **Save Changes**. You stay on the plan's page, and the button changes to **Saved**. Once a plan has subscriptions that aren't cancelled, you can change only **Company Default**, **Show Savings As**, **Allow Skips**, **Max Skips Allowed** and **Apply Discount To Volume**. You can also raise **Max Billing Cycles** or turn it off. If you change only other fields, or lower **Max Billing Cycles** or turn it on, an error message appears and nothing is saved. Changes to other fields aren't saved, even when the save succeeds, so reload the plan to check what was saved. ### Activate or deactivate plans In the plans list, open a plan's actions menu. To change several plans, select their rows and open the actions menu in the table header. Choose **Toggle Status**. Each plan switches to the opposite status. You can also open a plan, change its **Status**, and click **Save Changes**. Some plans can't be deactivated. See [Why can't I delete or deactivate a plan?](#cannot-delete-or-deactivate). ### Make a plan the company default In the plans list, click the plan you want as the default. It must be **Active**. If it's **Inactive**, activate it first. See [Activate or deactivate plans](#activate-or-deactivate-plans). Turn on the **Company Default** switch. Click **Save Changes**. This plan becomes the company default, and the plan that was the default before no longer is. ### Delete a plan In the plans list, choose **Delete** from the plan's actions menu. In the **Delete Subscription Plan?** dialog, click **Delete Subscription Plan**. To delete several plans, select their rows and choose **Delete** from the table header's menu. You can also open a plan and click **Delete** at the top of the page. Deleting a plan can't be undone. Some plans can't be deleted. See [Why can't I delete or deactivate a plan?](#cannot-delete-or-deactivate). ## FAQ You can't delete or deactivate the company default plan. To move the default to another plan, see [Make a plan the company default](#make-a-plan-the-company-default). You'll see this in two places: * In the plans list, an error message asks you to set another plan as the company default first. * On the default plan's page, **Delete**, **Status** and the **Company Default** switch are grayed out. You can't delete a plan that has subscriptions, including cancelled ones. You also can't delete a plan that an enrollment uses as its subscription plan. If you try, an error message appears. You can't change a plan's status while it has subscriptions that aren't cancelled. For such a plan, **Toggle Status** shows an error message. When you select several plans and use the table header's menu: if the selection includes the company default plan, an error message appears and none of them change. Otherwise, the action applies to every plan it can. Each plan it can't change or delete shows its own error message. The **Pricing Strategy** is **Defined on product**. With that strategy, the plan uses each variant's own subscription price, which you set in the product details. Choose **Percent Off** to enter a percentage. You associate plans with products from each product's page, not from this screen. Open the product, and on its **Subscription Plans** card click **Manage Subscription Plans**. Turn on the plans you want, click **Done**, then click **Save** on the product page. For a bundle, turn on the **Subscription Plans** switch on the bundle's page first. Then click **Manage Subscription Plans**, or click a plan in the list if the bundle already has plans, and continue as above. Check that **Subscription Plan Name** isn't empty. If **Allow Skips** or **Max Billing Cycles** is on, choose a number for it. A plan with **Company Default** turned on must also be **Active**. **Billing Interval**, **Fulfillment Frequency** and **Volume Frequency** can each be at most **Every 29**. If the plan has subscriptions that aren't cancelled, you can change only some fields. See [Edit a plan](#edit-a-plan). Your role can view subscription plans but doesn't have **Full access** for **Subscription Plans**. Without it, plans also don't open when you click them. Ask an admin who manages roles to update your role. See [Roles](/help/admin/settings/roles). ## Related pages * [Settings](/help/admin/settings) * [Roles](/help/admin/settings/roles)