> ## 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. # Preview an item for an autoship profile > Prices a recurring item for an autoship profile and says what joining it changes, without adding it. The item takes the profile's plan, address, card and next bill date. `quote.outcome` is `ok` when the item would have the same facts on its own, and `align_required` when joining changes at least one of them; `quote.alignments` lists those facts. Nothing is written. Send `quote.confirmation` to the add as `confirmation`. It binds every term in the quote, so the add refuses with `quote_changed` when any of them changed in between. Requires the `subscriptions` update permission and an admin, and the autoship_profiles feature to work for the company. The profile is the one whose members are exactly `subscription_tokens`, among the subscriptions of the customer who owns `{token}`. An address or card must be that customer's. The lifecycle notes credit the admin. Returns `403` naming the failed check in `errors.error` when the feature is off, `404` when the subscription is not the company's or a token is not the customer's, `409` with `meta.code` `profile_changed` when the profile's members changed since the client read them, `422` when the change is refused (the reason is in `meta.code`), and `401` when unauthenticated. Responses are not cached. ## OpenAPI ````yaml /api-reference/company-v0.yaml post /api/subscriptions/{token}/profile/items/preview openapi: 3.1.0 info: title: Fluid Company 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/subscriptions/{token}/profile/items/preview: post: tags: - subscriptions summary: Preview an item for an autoship profile description: > Prices a recurring item for an autoship profile and says what joining it changes, without adding it. The item takes the profile's plan, address, card and next bill date. `quote.outcome` is `ok` when the item would have the same facts on its own, and `align_required` when joining changes at least one of them; `quote.alignments` lists those facts. Nothing is written. Send `quote.confirmation` to the add as `confirmation`. It binds every term in the quote, so the add refuses with `quote_changed` when any of them changed in between. Requires the `subscriptions` update permission and an admin, and the autoship_profiles feature to work for the company. The profile is the one whose members are exactly `subscription_tokens`, among the subscriptions of the customer who owns `{token}`. An address or card must be that customer's. The lifecycle notes credit the admin. Returns `403` naming the failed check in `errors.error` when the feature is off, `404` when the subscription is not the company's or a token is not the customer's, `409` with `meta.code` `profile_changed` when the profile's members changed since the client read them, `422` when the change is refused (the reason is in `meta.code`), and `401` when unauthenticated. Responses are not cached. operationId: commerce_v0_preview_subscription_profile_item parameters: - name: token in: path required: true description: A subscription of the customer whose profile changes. schema: type: string requestBody: required: true content: application/json: example: subscription_tokens: - sb_7Qm2VxK9pRtL4wNc8HzJdF - sb_4Mw9Tc2Kd7Rx5Hb8Lq3Pn variant_id: 4821 quantity: 2 schema: type: object additionalProperties: false required: - subscription_tokens - variant_id - quantity properties: subscription_tokens: description: >- The member tokens of the profile, as the client last read them. type: array minItems: 2 items: type: string variant_id: description: The variant to add. It must belong to the company. type: integer quantity: description: How many units each renewal ships. type: integer minimum: 1 responses: '200': description: >- What joining the profile would change, and the confirmation the add takes back. content: application/json: schema: $ref: '#/components/schemas/SubscriptionProfileItemPreviewResponse' example: quote: outcome: align_required alignments: - field: date alignable: true next_bill_date: '2026-10-14' billing_interval: 1 billing_interval_unit: month address: id: 3310 name: Michael Scott address1: 1725 Slough Avenue address2: null address3: null city: Scranton state: PA subdivision_code: US-PA postal_code: '18505' country_code: US phone: null country_num_code: 840 default: true payment_method: id: 7702 payment_type: Credit Card details: card_brand: Visa last_four: '4242' item: variant_id: 4821 label: Dunder Mifflin Toner Cartridge quantity: 2 price: '90.0' total: '180.0' currency_code: USD confirmation: >- eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDVG9KYzNWaWFtVmpkQ0lMY0hKbGRtbGxkdz09In19 meta: request_id: 0d6c3f92-8b1e-4a75-9d2c-4f7e1a5b8c30 timestamp: '2026-09-30T14:05:22Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/StandardUnauthorizedResponse' '403': description: >- Not an admin or a droplet, missing the subscriptions update permission, or the autoship_profiles feature does not work for the company. A closed feature names the failed check in errors.error: subscription_pro_inactive, release_flag_unavailable, release_flag_off, setting_off or bundle_subscriptions_off. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '404': description: >- The subscription is not the company's, or a token is not its customer's. content: application/json: schema: $ref: '#/components/schemas/SubscriptionProfileErrorResponse' '409': description: >- The profile changed since the client read it. Nothing was written; reload the profile and try again. content: application/json: schema: $ref: '#/components/schemas/SubscriptionProfileErrorResponse' '422': description: >- Invalid parameters, or the item cannot join the profile. Nothing was written. content: application/json: schema: $ref: '#/components/schemas/SubscriptionProfileErrorResponse' security: - bearer_auth: [] components: schemas: SubscriptionProfileItemPreviewResponse: description: What joining an autoship profile would change for an item. type: object additionalProperties: false required: - quote - meta properties: quote: $ref: '#/components/schemas/SubscriptionProfileItemQuote' 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' 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). type: string SubscriptionProfileItemQuote: description: | What an item would take on when it joins an autoship profile: the profile's plan cadence, address, card and next bill date, and the price one unit renews at. type: object additionalProperties: false required: - outcome - alignments - next_bill_date - billing_interval - billing_interval_unit - address - payment_method - item - confirmation properties: outcome: description: | `ok` when the item has the same facts as the profile on its own. `align_required` when joining gives it profile facts it would not have on its own; the add then needs `confirmation`. type: string enum: - ok - align_required alignments: description: >- The profile facts the item takes that it would not have on its own. In practice `date`, and `preferred_shipping_method` when the profile has one. Empty when `outcome` is `ok`. type: array items: type: object additionalProperties: false required: - field - alignable properties: field: type: string enum: - date - address - volume_rep - preferred_shipping_method - auto_apply_points - payment_method - cadence - timezone alignable: description: Whether the item can take the profile's value. type: boolean next_bill_date: description: >- The date the item first bills and ships, with the profile's next order. type: string format: date billing_interval: description: The plan interval the item shares with the profile. type: integer billing_interval_unit: description: The unit of `billing_interval`. type: string enum: - day - week - month - year address: description: The shipping address the item takes from the profile. anyOf: - $ref: '#/components/schemas/SubscriptionProfileAddress' - type: 'null' payment_method: description: The payment method the item takes from the profile. anyOf: - $ref: '#/components/schemas/SubscriptionProfilePaymentLabel' - type: 'null' item: type: object additionalProperties: false required: - variant_id - label - quantity - price - total - currency_code properties: variant_id: type: integer label: description: The product title. Empty string when the product is gone. type: string quantity: type: integer price: description: Decimal string. What each renewal charges for one unit. type: string total: description: Decimal string. `price` times `quantity`. type: string currency_code: description: ISO 4217 code of `price` and `total`. type: string confirmation: description: >- A signed token that binds every term above. It is valid for one hour, and only the add for the same customer accepts it. type: string Meta: type: - object - 'null' properties: request_id: type: - string - number - integer - 'null' timestamp: type: - string - number - integer - 'null' format: date-time code: type: string description: Machine code for the refusal, for example `payment_unconfirmed`. payment_uuid: type: string description: >- Present with `payment_unconfirmed`. The payment to look up before charging again. error_details: type: array minItems: 1 description: >- Every reason this checkout was refused, each with a stable `code`, the cart `field` to fix, and the `payment` outcome. items: $ref: '#/components/schemas/CheckoutErrorDetail' coded_recovery: type: boolean description: >- Present and true when the company routes checkout refusals by `error_details` (CHECKOUT_CODED_REFUSALS). Temporary; removed with that flag. 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' SubscriptionProfileAddress: type: object additionalProperties: false properties: id: type: - integer - 'null' name: type: - string - 'null' address1: type: - string - 'null' address2: type: - string - 'null' address3: type: - string - 'null' city: type: - string - 'null' state: type: - string - 'null' subdivision_code: type: - string - 'null' postal_code: type: - string - 'null' country_code: type: - string - 'null' phone: type: - string - 'null' country_num_code: type: - integer - 'null' default: type: - boolean - 'null' SubscriptionProfilePaymentLabel: description: | The payment method an autoship profile renews on, named for display ("Visa 4242"). It carries no PayPal vault id or id token, no card expiry and no billing address. type: object additionalProperties: false required: - id - payment_type - details properties: id: type: integer payment_type: description: The kind of payment method, such as `Credit Card` or `PayPal`. type: string details: type: object additionalProperties: false required: - card_brand - last_four properties: card_brand: description: >- The card network, such as `Visa`. `null` for a payment method that is not a card. type: - string - 'null' last_four: description: >- The card's last four digits. `null` for a payment method that is not a card. type: - string - 'null' CheckoutErrorDetail: description: >- One refusal reason, in the same vocabulary as `checkout_blockers`, with where to send the shopper and what happened to the payment. type: object additionalProperties: false required: - code - field - payment - message properties: code: type: string description: Stable refusal code. Codes reuse the `checkout_blockers` codes. field: type: - string - 'null' description: >- The cart API path to send the shopper to, for example `shipping_address.postal_code` or `items[123]`, or null. payment: type: string enum: - not_attempted - declined - unknown - held description: >- `not_attempted`: fix the cause and resubmit. `declined`: the payment was refused; resubmit with another method. `declined` reflects the stored payment status; for some gateways an unconfirmed failure is still reported as `declined`. `unknown`: money may have moved; check the order before charging again. `held`: the cart's only money is the payment a resubmit reuses. Fix the field and resubmit with the same payment method; checkout will not charge again. message: type: string description: The English message for this entry. Not translated. 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.