> ## 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. # Publish a tenure program version > Publishes the proposed tiers and scope as the program's next version and puts it in force. The request carries the counts the preview returned. The server counts again under the program lock and refuses with 409 preview_stale when anything differs, with the current current_version_id, moves_up, moves_down and stays in error.details. Nothing is written then. An archived program is 409 archived. Every 422 the preview gives applies here too, and a request without previewed is 422. After the publish commits, subscriptions move onto the new tiers in the background. ## OpenAPI ````yaml /api-reference/settings-v0.yaml post /api/subscription_pro/tenure_programs/{id}/versions openapi: 3.1.0 info: title: Fluid Settings API description: | **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, every operation in this API that resolves the company from the request's credential refuses a credential for it with `403` and the body `{"error": ""}`, before the operation runs. The refusal is documented here once rather than on each operation. version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] paths: /api/subscription_pro/tenure_programs/{id}/versions: post: tags: - subscription-pro summary: Publish a tenure program version description: >- Publishes the proposed tiers and scope as the program's next version and puts it in force. The request carries the counts the preview returned. The server counts again under the program lock and refuses with 409 preview_stale when anything differs, with the current current_version_id, moves_up, moves_down and stays in error.details. Nothing is written then. An archived program is 409 archived. Every 422 the preview gives applies here too, and a request without previewed is 422. After the publish commits, subscriptions move onto the new tiers in the background. operationId: settings_v0_publish_subscription_pro_tenure_program parameters: - name: id in: path required: true description: The tenure program's id. schema: type: integer requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TenureProgramPublishRequest' example: tiers: - from: 3 label: Silver percentage_value: '10' - from: 6 label: Gold flat_value: '5.50' scope: all scope_ids: [] apply_to_volume: true previewed: current_version_id: null moves_up: 12 moves_down: 0 stays: 40 responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/TenureProgramResponse' example: tenure_program: id: 41 name: Loyalty status: active axis: paid_orders scope: all scope_ids: [] apply_to_volume: true archived_at: null archive_discounts: null current_version: id: 77 version: 1 created_at: '2026-10-10T14:05:31Z' tiers: - from: 3 to: 6 label: Silver discount_type: percentage percentage_value: '10.0' flat_value: null - from: 6 to: null label: Gold discount_type: flat percentage_value: null flat_value: '5.5' created_at: '2026-10-10T14:00:00Z' updated_at: '2026-10-10T14:05:31Z' status: 201 meta: request_id: 7d2f4c1a-9b3e-4f6d-8a21-3c5e0b9f1d42 timestamp: '2026-10-10T14:05:31Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/StandardUnauthorizedResponse' '403': description: Not an admin, or missing the orders.settings permission content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '404': description: No such program in this company content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '409': description: >- The counts changed since the preview (preview_stale), or the program is archived (archived) content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '422': description: >- Invalid values (invalid), a tier breaks a ladder rule (invalid_tier), the tenure pricing gate is closed, or previewed is missing content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: TenureProgramPublishRequest: type: object additionalProperties: false required: - tiers - scope - scope_ids - apply_to_volume - previewed properties: tiers: type: array minItems: 1 maxItems: 10 items: $ref: '#/components/schemas/TenureTierInput' description: The ladder, ascending by from. scope: type: string enum: - all - plans - products description: Which subscriptions the program covers once published. scope_ids: type: array maxItems: 500 items: type: integer description: Empty for all, otherwise the company's plan or product ids. apply_to_volume: type: boolean description: Whether the tier discounts reduce volume as well as price. previewed: allOf: - $ref: '#/components/schemas/TenureProgramPreviewCounts' description: >- The counts the preview returned for this same ladder and scope. The publish counts again and is refused with 409 (preview_stale) when they differ. TenureProgramResponse: type: object additionalProperties: false required: - tenure_program - status - meta properties: tenure_program: $ref: '#/components/schemas/TenureProgram' status: type: integer enum: - 200 - 201 meta: $ref: '#/components/schemas/Meta' StandardUnauthorizedResponse: description: Common legacy unauthorized response envelope. allOf: - $ref: '#/components/schemas/StandardErrorResponse' StandardErrorResponse: description: >- Common legacy error response envelope. Older endpoints may return one or more of these fields depending on the controller path. type: object properties: message: type: string error: $ref: '#/components/schemas/ErrorMessage' error_message: $ref: '#/components/schemas/ErrorMessage' errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' additionalProperties: $ref: '#/components/schemas/JsonValue' TenureTierInput: type: object required: - from - label description: >- One tier of a ladder, as the merchant sends it. A key not listed here is ignored. properties: from: type: integer minimum: 1 description: >- The paid order or month the tier starts at, inclusive. At least 2 on paid_orders, because the checkout order is order 1, and at least 1 on months_subscribed. Tiers ascend by from. to: type: integer description: >- Optional. When sent it must equal the next tier's from, and the top tier sends none. A tier always ends where the next one starts. label: type: string minLength: 1 maxLength: 50 description: The tier's name, shown to the merchant. percentage_value: type: string pattern: ^[0-9]+(\.[0-9]+)?$ description: >- Percent off, above 0 and at most 100, with at most 2 decimals. Send exactly one of percentage_value or flat_value. flat_value: type: string pattern: ^[0-9]+(\.[0-9]+)?$ description: >- Amount off in the subscription's currency, above 0 and below 100000000, with at most 2 decimals. TenureProgramPreviewCounts: type: object additionalProperties: false required: - current_version_id - moves_up - moves_down - stays properties: current_version_id: type: - integer - 'null' description: >- The version in force when the counts were made. Null before the first publish. moves_up: type: integer minimum: 0 description: Subscriptions that would get a higher tier or a first tier.: null moves_down: type: integer minimum: 0 description: >- Subscriptions that would get a lower tier or lose their tier. They keep the old tier until their next renewal. stays: type: integer minimum: 0 description: Everyone else in scope including subscriptions that earn no tier.: null TenureProgram: type: object additionalProperties: false required: - id - name - status - axis - scope - scope_ids - apply_to_volume - archived_at - archive_discounts - current_version - created_at - updated_at properties: id: type: integer name: type: string status: type: string enum: - draft - active - archived axis: type: string enum: - paid_orders - months_subscribed scope: type: string enum: - all - plans - products scope_ids: type: array items: type: integer apply_to_volume: type: boolean description: >- Whether the tier discounts of the version in force reduce volume. False before the first publish. archived_at: type: - string - 'null' format: date-time description: When the program was archived. Null unless archived. archive_discounts: type: - string - 'null' enum: - keep - remove_at_next_renewal - null description: >- What the archive did with the tier discounts subscriptions hold. Null unless archived. current_version: oneOf: - $ref: '#/components/schemas/TenureProgramVersion' - type: 'null' description: The tiers in force. Null for a draft. created_at: type: string format: date-time updated_at: type: string format: date-time Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time ErrorMessage: description: An API error message represented as text or structured JSON. anyOf: - type: string - $ref: '#/components/schemas/ErrorBag' - type: 'null' 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' 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' TenureProgramVersion: type: object additionalProperties: false required: - id - version - created_at - tiers properties: id: type: integer version: type: integer minimum: 1 description: The version number counted from 1 for the program.: null created_at: type: string format: date-time tiers: type: array items: $ref: '#/components/schemas/TenureProgramTier' description: The tiers in ascending order of from. ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' TenureProgramTier: type: object additionalProperties: false required: - from - to - label - discount_type - percentage_value - flat_value properties: from: type: integer description: The paid order or month the tier starts at inclusive.: null to: type: - integer - 'null' description: >- Where the tier ends, exclusive. It is the next tier's from, and null on the top tier. label: type: - string - 'null' description: The tier's name. Null only for a version written without labels. discount_type: type: string enum: - percentage - flat description: Whether the tier takes a percent or an amount off. percentage_value: type: - string - 'null' description: Percent off as a decimal string. Null on a flat tier. flat_value: type: - string - 'null' description: Amount off as a decimal string. Null on a percentage tier. 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.