> ## 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. Before authenticated calls are possible, the merchant must sign the agent in to the Fluid CLI with the emailed code and --shop set to the company's fluid_shop (which also confirms the signup), or open the emailed confirmation link and give the agent an API token. > 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 on an operation whose spec documents those params — mostly the unversioned company-v0 admin surface, plus some lists on other surfaces, versioned ones included; page every other list with cursors. > 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 except two operations that take no credential, POST /api/company (create a company) and GET /api/agreements/{id} — 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. # List the items a customer can add to an autoship profile > Lists the variants the customer may add to the autoship profile, a page at a time, in `variant_id` order. Send a listed `variant_id` to the preview, then to the add. A variant is listed when all of these hold: - Its product belongs to the company, is active and public, is not a draft, archived, discarded or scheduled for later, and is not a bundle. - The variant is active, not discarded, and physical (not digital). - Its product offers the profile's plan: an active link to an active plan. - It is active in the country of the profile's address. - The company sells that country in the profile's currency. When it does not, the list is empty. - It is in stock for that country: it does not track quantity, it keeps selling at zero stock, or the country's warehouse has some available. - The profile does not already have it. `query` keeps the variants that match every word, in any case, in the product title, the variant title or display name, or the SKU. A blank `query` keeps them all. `catalog_price` is what one unit renews at on the profile's plan at the customer's pricing tier. It is before automatic discounts and quantity breaks. The preview prices the item exactly. Requires a customer bearer token. The profile is the one whose members are exactly `subscription_tokens`. Returns `404` when a token is not the customer's or Subscription Pro does not offer autoship profiles to the company, `409` with `meta.code` `profile_changed` when the profile's members changed since the client read them, `422` when the profile has no saved address (`meta.code` `address_required`), when the profile refuses every item the list would hold (`meta.code` `join_refused`, the preview's reasons in `errors.refusals`, for example members that have no pricing modes yet), when the cursor is invalid or expired, or when a parameter is invalid, and `401` when unauthenticated. ## OpenAPI ````yaml /api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscription-profiles/items/eligible openapi: 3.1.0 info: title: Fluid Checkout API description: > **Fluid Checkout API — for building a checkout directly against REST.** Use this surface if you are integrating server-to-server or building your own checkout UI. It covers the full order lifecycle (cart → address → shipping → discount → complete → order) plus the logged-in customer's account: saved addresses, saved payment methods, order history, loyalty points, and subscription management (pause, resume, skip, cancel, retry). **The cart token in the URL scopes cart access** — creating a cart, adding items, applying a discount, and completing a cart need no bearer token. Among the cart operations, a Bearer token is required for `carts/{cart_token}/sync`, `carts/{cart_token}/volume_rep`, and `carts/{cart_token}/discount/manual`. It is also required conditionally when `PATCH carts/{cart_token}` selects an enrollment target with `member_type_id`; profile-only PATCH requests remain public. Off the cart, a token is required for everything under `customers/me` and `subscriptions`, and for the store and directory lookups (`store/config`, `store/languages`, `reps`, `users`), `subscription_bundles` and `subscription-profiles`. `store/countries` accepts a token but does not require one — it returns the same list either way. **If you are using the `@fluid-app` FairShare SDK in a theme or storefront, you are not calling this surface** — the SDK calls the Fluid Public SDK API (`public-v2025-06`). Do not mix the two against one cart: they share the same cart records and services, but their request shapes differ. See [Choosing a cart surface](https://docs.fluid.app/api/choosing-a-cart-surface) for the operation map and boundary. **Sandbox test companies.** A sandbox test company is linked to a live company. While the test company cannot be reached, because sandbox access is turned off for its live company or the live company was deleted: - a cart token for one of its carts answers exactly as a token no cart holds, with the operation's documented `404` (cart not found), so the response does not reveal that the cart exists; - an operation that resolves the company from a bearer credential refuses that credential with `403` and the body `{"error": ""}`, before the operation runs. These refusals are documented here once rather than on each operation. version: v2026-04 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] tags: - name: carts description: >- Create, read, and mutate checkout carts (email, address, country, language, shipping, recalculation, completion). - name: cart-auth description: >- Cart-scoped customer authentication — magic-link challenge, verification, identity, and logout. - name: cart-discount description: >- Apply, list, and remove promo codes (discount codes) on a cart, including admin manual discounts. - name: cart-items description: Add, update, and remove line items on a cart. x-fluid-section: Checkout - name: cart-points description: Apply and remove loyalty points on a cart. - name: customers description: The authenticated customer's profile and company memberships. - name: customer-addresses description: The authenticated customer's saved shipping/billing addresses. - name: customer-orders description: The authenticated customer's order history. - name: customer-payment-methods description: The authenticated customer's saved payment methods and tokenization. - name: customer-points description: The authenticated customer's loyalty point balances. - name: directory description: Company rep and user directory lookups. - name: enrollments description: >- Public enrollment forms — retrieve a form and submit, update, or upload field answers. - name: orders description: Public order lookup by token. - name: products description: Public product queries for the storefront checkout. - name: store description: >- Store-level checkout configuration — countries, languages, address fields, agreements, drop zones, and Apple Pay domain verification. x-fluid-section: Checkout - name: subscriptions description: >- Manage subscriptions — pause, resume, skip, cancel, reactivate, retry, and failed-cycle waivers. - name: subscription-manage-link description: >- The subscriptions a manage link reaches. The bearer is the link's scoped token (`sml_...`, from the `manage_url` of the subscription_upcoming_renewal webhook), not a session. It names one company, the subscriptions of one renewal order and the actions it allows, and it expires at the end of the day after the local bill date. Only these operations accept it, and they accept no other credential. The responses carry no customer data. x-fluid-section: Checkout - name: subscription-bundles description: List and create subscription bundles. - name: subscription-profiles description: Change an autoship profile as a whole. Requires Subscription Pro. x-fluid-section: Checkout paths: /api/checkout/v2026-04/subscription-profiles/items/eligible: post: tags: - subscription-profiles summary: List the items a customer can add to an autoship profile description: > Lists the variants the customer may add to the autoship profile, a page at a time, in `variant_id` order. Send a listed `variant_id` to the preview, then to the add. A variant is listed when all of these hold: - Its product belongs to the company, is active and public, is not a draft, archived, discarded or scheduled for later, and is not a bundle. - The variant is active, not discarded, and physical (not digital). - Its product offers the profile's plan: an active link to an active plan. - It is active in the country of the profile's address. - The company sells that country in the profile's currency. When it does not, the list is empty. - It is in stock for that country: it does not track quantity, it keeps selling at zero stock, or the country's warehouse has some available. - The profile does not already have it. `query` keeps the variants that match every word, in any case, in the product title, the variant title or display name, or the SKU. A blank `query` keeps them all. `catalog_price` is what one unit renews at on the profile's plan at the customer's pricing tier. It is before automatic discounts and quantity breaks. The preview prices the item exactly. Requires a customer bearer token. The profile is the one whose members are exactly `subscription_tokens`. Returns `404` when a token is not the customer's or Subscription Pro does not offer autoship profiles to the company, `409` with `meta.code` `profile_changed` when the profile's members changed since the client read them, `422` when the profile has no saved address (`meta.code` `address_required`), when the profile refuses every item the list would hold (`meta.code` `join_refused`, the preview's reasons in `errors.refusals`, for example members that have no pricing modes yet), when the cursor is invalid or expired, or when a parameter is invalid, and `401` when unauthenticated. operationId: checkout_v2026_04_list_subscription_profile_eligible_items requestBody: required: true content: application/json: example: subscription_tokens: - sb_7Qm2VxK9pRtL4wNc8HzJdF - sb_4Mw9Tc2Kd7Rx5Hb8Lq3Pn query: toner page: limit: 20 schema: type: object additionalProperties: false required: - subscription_tokens properties: subscription_tokens: description: >- The member tokens of the profile, as the client last read them. type: array minItems: 2 items: type: string query: description: Words to search for. Every word must match. type: - string - 'null' maxLength: 100 page: type: object additionalProperties: false properties: cursor: description: The `next_cursor` or `prev_cursor` of the page before. type: - string - 'null' limit: description: Items per page. Defaults to 20. type: - integer - 'null' minimum: 1 maximum: 50 responses: '200': description: One page of the variants the customer may add. content: application/json: schema: $ref: '#/components/schemas/SubscriptionProfileEligibleItemsResponse' example: items: - variant_id: 4821 product_id: 912 name: Dunder Mifflin Toner Cartridge variant_title: Black image_url: https://cdn.fluid.app/dundermifflin/toner-black.jpg catalog_price: '90.0' currency_code: USD meta: request_id: 0d6c3f92-8b1e-4a75-9d2c-4f7e1a5b8c30 timestamp: '2026-09-30T14:05:22Z' pagination: cursor: null limit: 20 prev_cursor: null next_cursor: null total_count: 1 total_pages: 1 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '404': description: Not found, or autoship profiles are off for the company. content: application/json: schema: $ref: '#/components/schemas/SubscriptionProfileErrorResponse' '409': description: >- The profile changed since the client read it. Reload the profile and try again. content: application/json: schema: $ref: '#/components/schemas/SubscriptionProfileErrorResponse' '422': description: Invalid parameters or cursor, or the profile has no saved address. content: application/json: schema: $ref: '#/components/schemas/SubscriptionProfileErrorResponse' security: - bearer_auth: [] components: schemas: SubscriptionProfileEligibleItemsResponse: description: One page of the variants a customer may add to an autoship profile. type: object additionalProperties: false required: - items - meta properties: items: type: array items: $ref: '#/components/schemas/SubscriptionProfileEligibleItem' meta: description: The default meta envelope plus cursor pagination. type: object additionalProperties: false required: - request_id - timestamp - pagination properties: request_id: type: - string - 'null' timestamp: type: string format: date-time pagination: description: Cursor pagination. Empty object when the page has no items. oneOf: - type: object additionalProperties: false - type: object additionalProperties: false required: - cursor - limit - prev_cursor - next_cursor - total_count - total_pages properties: cursor: description: The cursor of this page. type: - string - 'null' limit: type: integer prev_cursor: description: >- Send as `page.cursor` for the previous page. `null` on the first page. type: - string - 'null' next_cursor: description: >- Send as `page.cursor` for the next page. `null` on the last page. type: - string - 'null' total_count: type: integer total_pages: type: integer UnauthorizedResponse: type: object properties: message: type: string required: - message SubscriptionProfileErrorResponse: description: | A refused profile write. Nothing was written. `meta.code` names the reason on a `409` or a domain `422`; it is absent on a `404` and on a `422` for invalid parameters. type: object additionalProperties: false required: - error_message - errors - meta properties: error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: type: object additionalProperties: false required: - request_id - timestamp properties: request_id: type: - string - 'null' timestamp: type: string format: date-time code: description: > Why the write was refused. `profile_changed` (409): the tokens no longer name one profile; `errors.subscription_tokens` lists the profile's current members. `profile_would_change`: the change would split the profile. `plan_not_offered`: an item's product does not offer the plan. `skip_refused`: a member cannot skip. `item_would_not_rejoin`: the skipped item would not land on the profile's next date. Other values come from the address, payment method, date and billing-cycle checks the subscription writes share. On the item add, `quote_changed` (409): the profile's date, address, card or plan or the item's price changed since the preview, or the confirmation is expired or is for other terms; preview again. 422: `confirmation_required` (the preview's outcome is `align_required`, so the add needs its `confirmation`); `join_refused` (`errors.refusals` lists the reasons: `currency`, `country`, `tax_pricing_mode`, `shipping_pricing_mode`, `digital`, `customer`, `member`, `plan_not_offered`); `item_unavailable`; `item_not_created` (`errors` carry the subscription create errors); `request_key_reused` (the `request_key` added another item); `address_required`; `invalid_variant` (`variant_id` not found for the company). On the cart autoship profile choice, `quote_changed` (409): the profile's date, address, card or plan changed since the list, or the confirmation is expired or is for another cart; list again. 422: `join_refused` (`errors.refusals` lists the reasons, as on the list); `no_subscription_items` (the cart creates no subscription). type: string SubscriptionProfileEligibleItem: description: | A variant the customer may add to an autoship profile. Send `variant_id` to the preview. type: object additionalProperties: false required: - variant_id - product_id - name - variant_title - image_url - catalog_price - currency_code properties: variant_id: type: integer product_id: type: integer name: description: The product title. type: string variant_title: description: >- The variant's display name, else its title. `null` when it has neither. type: - string - 'null' image_url: description: >- The variant's first image, else its own image, else the product's first image, else the product's image. `null` when there is none. type: - string - 'null' catalog_price: description: > Decimal string. What one unit renews at on the profile's plan, at the customer's pricing tier, before automatic discounts and quantity breaks. The preview prices the item exactly. `null` when the catalog has no price for it. type: - string - 'null' currency_code: description: ISO 4217 code of `catalog_price`. type: string ErrorBag: description: >- Validation errors keyed by field, a list of errors, a single error message, or null when no structured error details are available. anyOf: - type: string - type: array items: $ref: '#/components/schemas/ErrorValue' - type: object additionalProperties: $ref: '#/components/schemas/ErrorValue' - type: 'null' ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' JsonValue: description: >- Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract. anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.