> ## 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. # List runtime bundle candidates > Streams the authenticated member's active, not-disabled subscriptions, including those without a billing date, newest created first with a stable internal tie breaker. Each page is only a fragment: clients must drain every page before constructing complete groups, counts or saved gross totals, and hydrate subscription UUIDs for display details. No complete bundle or persistent bundle ID is returned. Concurrent edits can change membership or keys; refresh the stream before relying on a complete grouping. Grouping follows the existing snapshot/address/customer fallback policy; a native profile without a legacy Customer does not introduce a new address fallback. Saved line amounts are not renewal quotes. Company bundling must be enabled; unsafe related references refuse the page. Only page[cursor] and page[limit] are accepted. Responses are private and require revalidation. ## OpenAPI ````yaml /api-reference/member-commerce-v2026-10.yaml get /api/member/v2026-10/subscriptions/bundle-candidates openapi: 3.1.0 info: title: Fluid Member API v2026-10 — Commerce description: >- Order and product-subscription history for the authenticated member. The bearer credential determines member and company; query filters cannot change either. Uses the same member credentials as the People API. Money is serialized as decimal strings in the enclosing currency. Order item counts and individual shipment statuses are not exposed because maintained source fields do not yet exist. A subscription's next-charge total (next_total, next_order_preview) carries the known pre-reward-points renewal charge when it can be stated from stored facts without pricing the renewal; it is null for current-rate, bundled, tax-inclusive, tax-exempt, audience-discount, expiring-discount or missing-fact subscriptions. Its subtotal is net of discounts. Authoritative saved per-line amounts are also exposed on the detail's items[]. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary version: 2026-10 servers: - url: https://api.fluid.app description: Production API server - url: https://api.fluid.test description: Local development server security: - MemberBearer: [] tags: - name: orders description: The signed-in member’s own purchases and volume-credited orders. x-fluid-section: Members - name: subscriptions description: The signed-in member’s own product subscriptions. x-fluid-section: Members - name: carts description: >- The signed-in member's own carts, addressed by checkout token, and claiming a guest cart. x-fluid-section: Commerce paths: /api/member/v2026-10/subscriptions/bundle-candidates: get: tags: - subscriptions summary: List runtime bundle candidates description: >- Streams the authenticated member's active, not-disabled subscriptions, including those without a billing date, newest created first with a stable internal tie breaker. Each page is only a fragment: clients must drain every page before constructing complete groups, counts or saved gross totals, and hydrate subscription UUIDs for display details. No complete bundle or persistent bundle ID is returned. Concurrent edits can change membership or keys; refresh the stream before relying on a complete grouping. Grouping follows the existing snapshot/address/customer fallback policy; a native profile without a legacy Customer does not introduce a new address fallback. Saved line amounts are not renewal quotes. Company bundling must be enabled; unsafe related references refuse the page. Only page[cursor] and page[limit] are accepted. Responses are private and require revalidation. operationId: member_subscription_bundle_candidates_index parameters: - name: page[cursor] in: query description: >- Encrypted continuation valid for three days, bound to the member, company and fixed eligibility selection. Foreign or invalid cursors are refused. schema: type: string - name: page[limit] in: query description: >- Maximum candidate subscriptions returned, not maximum complete bundles. schema: type: integer minimum: 1 maximum: 100 default: 25 responses: '200': description: One fragment of the owned candidate stream, or an empty page. headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' content: application/json: schema: $ref: '#/components/schemas/SubscriptionBundleCandidatesEnvelope' example: status: 200 data: - id: 01983a21-7b23-7123-8123-123456789abc grouping_key: >- aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa next_billing_date: '2026-11-01' currency: USD quantity: 2 unit_price: '40.0' line_total: '80.0' meta: request_uuid: 01983a21-7b23-7123-8123-123456789abd timestamp: '2026-10-01T12:00:00Z' pagination: next_cursor: null '304': description: The authenticated member representation matches If-None-Match. headers: ETag: $ref: '#/components/headers/ETag' Cache-Control: $ref: '#/components/headers/CacheControl' '400': description: Malformed, expired, tampered or foreign-member continuation. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: Missing or unusable member credential. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '422': description: >- Unsupported parameter, invalid page value, disabled company bundling or unsafe related reference. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: headers: ETag: description: >- Fingerprint of this member's representation. Send it back in If-None-Match to skip the body while it is unchanged. schema: type: string CacheControl: description: Standard HTTP Cache-Control directive. Always private for this surface. schema: type: string example: max-age=60, private schemas: SubscriptionBundleCandidatesEnvelope: type: object description: >- One bounded fragment of candidate subscriptions; groups can span any number of pages. properties: status: type: integer description: HTTP response status. const: 200 data: type: array description: >- Owned candidates on this page, never a claim of complete bundle membership. items: $ref: '#/components/schemas/SubscriptionBundleCandidate' meta: allOf: - $ref: '#/components/schemas/ResponseMeta' - type: object properties: pagination: $ref: '#/components/schemas/PaginationMeta' required: - pagination required: - status - data - meta ErrorEnvelope: type: object description: Standard error envelope. properties: status: type: integer description: HTTP status code (mirrors the response status line). error: type: object properties: message: type: string description: Human-readable error message. details: type: object additionalProperties: true required: - message - details meta: $ref: '#/components/schemas/ResponseMeta' required: - status - error - meta SubscriptionBundleCandidate: type: object description: >- A saved subscription line eligible for runtime grouping, not a complete bundle. additionalProperties: false properties: id: type: string format: uuid description: Public subscription UUID used to hydrate display details. grouping_key: type: string pattern: ^[a-f0-9]{64}$ description: >- Member- and company-scoped opaque key derived from authoritative runtime grouping facts; not a persistent bundle ID. next_billing_date: type: - string - 'null' format: date description: >- Scheduled calendar date in the subscription's local timezone, including null for unscheduled candidates. currency: type: - string - 'null' description: Currency code for the saved gross line amounts. quantity: type: - integer - 'null' description: Saved subscription quantity. unit_price: type: - string - 'null' pattern: ^-?[0-9]+(\.[0-9]+)?$ description: >- Saved gross unit price as a decimal string without currency-exponent rounding; not a renewal quote. line_total: type: - string - 'null' pattern: ^-?[0-9]+(\.[0-9]+)?$ description: >- Saved gross unit price multiplied by quantity without currency-exponent rounding or renewal adjustments; null if either source is absent. required: - id - grouping_key - next_billing_date - currency - quantity - unit_price - line_total ResponseMeta: type: object description: Envelope metadata present on every response. properties: request_uuid: type: string format: uuid description: Server-generated UUIDv7 uniquely identifying this response. timestamp: type: string format: date-time description: ISO 8601 timestamp at which the server produced the response. required: - request_uuid - timestamp additionalProperties: true PaginationMeta: type: object description: Keyset pagination state for a list. additionalProperties: false properties: next_cursor: type: - string - 'null' description: Send as `page[cursor]` for the next page; null on the last page. required: - next_cursor securitySchemes: MemberBearer: type: http scheme: bearer description: | A member credential in the `Authorization: Bearer` header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.