> ## 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, run `fluid signup` from the Fluid CLI, or 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. # Preview what a blackout calendar would move > Counts the subscriptions the daily sweep would move now under the proposed blackout rules, so a merchant sees the effect before it saves them. A subscription counts when it is on a month or year plan, is active, or paused with a bill date, is not claimed by a renewal, and its local bill date is on a blocked day after the reminder window. The window is the merchant's reminder_lead_days, but at least 3 days. The blackout_dates feature need not be on, so a merchant can preview before it turns the feature on. Not found (404, subscription_pro_inactive) while Subscription Pro is not active, which fluid-admin reads as no count to show. Nothing is saved and no sweep is queued. Responses are not cached. ## OpenAPI ````yaml /api-reference/settings-v0.yaml post /api/subscription_pro/blackout_preview 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/blackout_preview: post: tags: - subscription-pro summary: Preview what a blackout calendar would move description: >- Counts the subscriptions the daily sweep would move now under the proposed blackout rules, so a merchant sees the effect before it saves them. A subscription counts when it is on a month or year plan, is active, or paused with a bill date, is not claimed by a renewal, and its local bill date is on a blocked day after the reminder window. The window is the merchant's reminder_lead_days, but at least 3 days. The blackout_dates feature need not be on, so a merchant can preview before it turns the feature on. Not found (404, subscription_pro_inactive) while Subscription Pro is not active, which fluid-admin reads as no count to show. Nothing is saved and no sweep is queued. Responses are not cached. operationId: settings_v0_preview_subscription_pro_blackout requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BlackoutPreviewRequest' example: blackout_rules: - name: Month end blocked_days: - 29 - 30 - 31 move_to_day: 28 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BlackoutPreviewResponse' example: moves: 3 by_day: '29': to: 28 count: 1 '30': to: 28 count: 2 status: 200 meta: request_id: 7d2f4c1a-9b3e-4f6d-8a21-3c5e0b9f1d42 timestamp: '2026-10-25T12:00:00Z' '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: >- Subscription Pro is not active for the company (subscription_pro_inactive). content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' example: error: message: Subscription Pro is not active details: error: subscription_pro_inactive status: 404 meta: request_id: 7d2f4c1a-9b3e-4f6d-8a21-3c5e0b9f1d42 timestamp: '2026-10-25T12:00:00Z' '422': description: >- The body is invalid: blackout_rules is missing, holds more than 20 rules, a field is out of range, a key is not allowed, a rule repeats a day, a move_to_day is blocked by any rule, or a move_to_day above 28 has a blocked day from 28 to the day before it. The rule's index and field are in details. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' example: error: message: Invalid parameters details: blackout_rules: '0': move_to_day: - is blocked by rule 2 status: 422 meta: request_id: 7d2f4c1a-9b3e-4f6d-8a21-3c5e0b9f1d42 timestamp: '2026-10-25T12:00:00Z' security: - bearer_auth: [] components: schemas: BlackoutPreviewRequest: type: object additionalProperties: false required: - blackout_rules properties: blackout_rules: type: array maxItems: 20 items: $ref: '#/components/schemas/BlackoutRuleInput' description: >- The proposed blackout calendar, as it would be saved. An empty list previews no rules and counts no moves. The same checks as a settings save apply: a rule's move_to_day may not be blocked by any rule, including a disabled one; a move_to_day above 28 may not have a blocked day from 28 to the day before it; and a rule may not repeat a day. BlackoutPreviewResponse: type: object additionalProperties: false required: - moves - by_day - status - meta description: >- The counts sit at the top level of the body, beside status and meta, with no wrapper key. properties: moves: type: integer minimum: 0 description: >- The number of subscriptions the daily sweep would move now under the proposed rules. by_day: type: object description: >- The moves per blocked day. A key is the day of the month, "1" to "31". A blocked day that holds no move is left out. additionalProperties: $ref: '#/components/schemas/BlackoutPreviewMove' status: type: integer enum: - 200 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' BlackoutRuleInput: type: object required: - blocked_days - move_to_day description: >- One blackout rule, as the merchant sends it. A key not listed here is ignored. properties: id: type: string format: uuid description: The rule's id. A rule sent without one gets a new id. name: type: string maxLength: 80 default: '' description: A label for the rule. enabled: type: boolean default: true description: >- Whether the rule is in force. A disabled rule blocks nothing, but its days still count for the checks when the calendar is saved. priority: type: integer minimum: -1000 maximum: 1000 default: 0 description: >- Decides an overlap between rules. The higher value wins, and a tie goes to the earlier rule in the list. blocked_days: type: array minItems: 1 maxItems: 30 items: type: integer minimum: 1 maximum: 31 description: >- The days of the month, 1 to 31, that a bill date may not fall on. A day may not repeat. move_to_day: type: integer minimum: 1 maximum: 31 description: >- The day a computed bill date moves to. A month with fewer days cuts it back to its last day. checkout_message: type: string maxLength: 500 default: '' description: The note a shopper sees when their date moves. BlackoutPreviewMove: type: object additionalProperties: false required: - to - count properties: to: type: integer minimum: 1 maximum: 31 description: The move_to_day the subscriptions on this blocked day move to. count: type: integer minimum: 1 description: The number of subscriptions that move off this blocked day. 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' ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - 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.