> ## 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. # Choose an autoship profile for a cart > Records that the cart's new subscriptions ship with an autoship profile. When the order completes, they are created as usual and then take the profile's next bill date, plan, address and card, so their first renewal ships in the profile's order. If the profile changed or the join is refused by then, they ship separately and the order confirmation says why. The order itself is never refused for this. Send the profile's `subscription_tokens` and `confirmation` from the list. Requires a customer bearer token, and the cart must be that customer's. Returns `404` when the cart is not the customer's, a token is not the customer's, or Subscription Pro does not offer autoship profiles to the company; `409` when the profile changed since the list (`meta.code` `profile_changed` or `quote_changed`); `422` when the subscriptions cannot ship with the profile; `410` for a processed cart. ## OpenAPI ````yaml /api-reference/checkout-v2026-04.yaml put /api/checkout/v2026-04/carts/{cart_token}/autoship-profile 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/carts/{cart_token}/autoship-profile: put: tags: - subscription-profiles summary: Choose an autoship profile for a cart description: | Records that the cart's new subscriptions ship with an autoship profile. When the order completes, they are created as usual and then take the profile's next bill date, plan, address and card, so their first renewal ships in the profile's order. If the profile changed or the join is refused by then, they ship separately and the order confirmation says why. The order itself is never refused for this. Send the profile's `subscription_tokens` and `confirmation` from the list. Requires a customer bearer token, and the cart must be that customer's. Returns `404` when the cart is not the customer's, a token is not the customer's, or Subscription Pro does not offer autoship profiles to the company; `409` when the profile changed since the list (`meta.code` `profile_changed` or `quote_changed`); `422` when the subscriptions cannot ship with the profile; `410` for a processed cart. operationId: checkout_v2026_04_choose_cart_autoship_profile parameters: - name: cart_token in: path required: true description: Cart token schema: type: string requestBody: required: true content: application/json: example: subscription_tokens: - sb_7Qm2VxK9pRtL4wNc8HzJdF - sb_4Mw9Tc2Kd7Rx5Hb8Lq3Pn confirmation: >- eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDVG9KYzNWaWFtVmpkQ0lMY0hKbGRtbGxkdz09In19 schema: type: object additionalProperties: false required: - subscription_tokens - confirmation properties: subscription_tokens: description: The profile's member tokens, as the list returned them. type: array minItems: 2 items: type: string confirmation: description: The profile's `confirmation` from the list. type: string responses: '200': description: The choice is recorded. content: application/json: schema: $ref: '#/components/schemas/CartAutoshipProfileChoiceResponse' example: selected_subscription_tokens: - sb_4Mw9Tc2Kd7Rx5Hb8Lq3Pn - sb_7Qm2VxK9pRtL4wNc8HzJdF meta: request_id: 0d6c3f92-8b1e-4a75-9d2c-4f7e1a5b8c30 timestamp: '2026-10-11T14:05:22Z' '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 list (`profile_changed` or `quote_changed`); list again. Or a redirect payment is open at the provider (`payment_in_progress`). Nothing was written. content: application/json: schema: anyOf: - $ref: '#/components/schemas/SubscriptionProfileErrorResponse' - $ref: '#/components/schemas/PaymentInProgressErrorResponse' '410': $ref: '#/components/responses/ProcessedCartResponse' '422': description: >- Invalid parameters, or the cart's subscriptions cannot ship with the profile. Nothing was written. content: application/json: schema: $ref: '#/components/schemas/SubscriptionProfileErrorResponse' security: - bearer_auth: [] components: schemas: CartAutoshipProfileChoiceResponse: description: The cart's autoship profile choice after the write. type: object additionalProperties: false required: - selected_subscription_tokens - meta properties: selected_subscription_tokens: description: >- The sorted member tokens of the chosen profile, or `null` after the choice is cleared. anyOf: - type: array items: type: string - type: 'null' meta: $ref: '#/components/schemas/CheckoutMeta' 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 PaymentInProgressErrorResponse: description: | 409 envelope for a cart write refused while a redirect payment is open at the provider (CURRENT-3992). `meta.cart` is the cart as it stands, so the client can show the pending payment without a second fetch. 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 - code - shop_url - cart properties: request_id: type: - string - 'null' timestamp: type: string format: date-time code: type: string enum: - payment_in_progress shop_url: type: string cart: a0a7edae-63cc-446d-a643-36476a4af4b1 error_details: type: array minItems: 1 description: >- Every reason this write 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. CheckoutMeta: type: object additionalProperties: false required: - request_id - timestamp properties: request_id: type: - string - 'null' timestamp: type: string 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. 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' 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. LockedCartErrorResponse: 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 - shop_url - cart properties: request_id: type: - string - 'null' timestamp: type: string format: date-time shop_url: type: string cart: 79e8e7dd-256d-4d9d-9299-527fd84dfac0 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' responses: ProcessedCartResponse: description: >- The cart is locked and can no longer be modified. Cart-mutation endpoints return this when the cart has already been processed (converted to an order), carries an authorized or captured charge (its prices are settled once money has moved), or, for enrollment carts, is in an authorized payment state. The body carries the full cart plus the store URL so the client can display the locked cart and redirect. content: application/json: schema: $ref: '#/components/schemas/LockedCartErrorResponse' 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.