> ## 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. > Navigation menu management is documented in themes/navigation-menus. These unversioned admin endpoints (/api/menus and nested menu_items) are verified against the implementation but are not yet in the synced OpenAPI specs. Use that reference for menu payloads and its flat page/per_page pagination; missing spec coverage does not make these endpoints unavailable. > 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. # Update company entity ## OpenAPI ````yaml /api-reference/onboarding-v0.yaml put /api/companies/{company_id}/entities/{id} openapi: 3.1.0 info: title: Fluid Onboarding API version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app - url: https://{company}.fluid.app description: Production server with company subdomain variables: company: default: myco description: Company subdomain security: [] paths: /api/companies/{company_id}/entities/{id}: put: tags: - entities summary: Update company entity operationId: onboarding_v0_update_company_entity parameters: - name: company_id in: path required: true example: 1 schema: type: integer - name: id in: path required: true example: 1 schema: type: integer requestBody: content: application/json: schema: $ref: >- #/components/schemas/UpdateCompanyEntityRequestBodyApplicationJsonSchema description: Request payload responses: '200': description: entity updated content: application/json: schema: type: object properties: entity: $ref: '#/components/schemas/OnboardingCompanyEntity' meta: $ref: '#/components/schemas/OnboardingMeta' required: - entity '401': description: unauthorized - company access denied content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '422': description: >- entity could not be updated - either the attributes are invalid, or the update takes the entity out of service while something live still references it. Both `archived` and `draft` are out of service and run the same guards, so either one is refused while the entity is still the company default, still has live payment accounts, or still has countries assigned to it, and those references must be moved first. A request naming the status the entity already holds is not an error - the retirement has nothing to do, and the rest of the payload is saved - so a client that round-trips the resource it just read is answered 200 content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: UpdateCompanyEntityRequestBodyApplicationJsonSchema: type: - object - 'null' properties: entity: $ref: '#/components/schemas/OnboardingUpdateCompanyEntityRequest' company_id: type: - integer - string - number - 'null' id: type: - integer - string - number - 'null' OnboardingCompanyEntity: type: - object - 'null' properties: legal_name: type: - string - number - integer - 'null' classification: type: - string - number - integer - 'null' trading_name: type: - string - number - integer - 'null' country_iso: type: - string - number - integer - 'null' address1: type: - string - number - integer - 'null' address2: type: - string - number - integer - 'null' city: type: - string - number - integer - 'null' province: type: - string - number - integer - 'null' postal_code: type: - string - number - integer - 'null' registration_number: type: - string - number - integer - 'null' date_of_incorporation: type: - string - number - integer - 'null' primary_mcc: type: - integer - string - number - 'null' secondary_mcc: type: - integer - string - number - 'null' phone_country_code: type: - string - number - integer - 'null' phone: type: - string - number - integer - 'null' website: type: - string - number - integer - 'null' tax_id: type: - string - number - integer - 'null' billing_descriptor: description: >- Card-statement descriptor for this legal entity, shown to customers in billing disclosures. Display only, never sent to the payment processor. Maximum 22 characters; letters, numbers, spaces and the characters & , . ' # * and -. type: - string - 'null' maxLength: 22 pattern: ^[a-zA-Z0-9 &,.'#*-]+$ principal_same_as_registered_address: type: - boolean - 'null' primary: type: - boolean - 'null' status: description: >- Lifecycle state. `draft` has not been put into service yet, `active` is in service, `inactive` is a pause it is expected to come back from, and `archived` is retired. Only `active` and `inactive` may be the company default, hold a payment account, or be the entity a country routes to. type: string enum: - draft - active - inactive - archived business_registration_file_url: type: - string - number - integer - 'null' business_registration_file_name: type: - string - number - integer - 'null' business_license_file_url: type: - string - number - integer - 'null' business_license_file_name: type: - string - number - integer - 'null' articles_of_incorporation_file_url: type: - string - number - integer - 'null' articles_of_incorporation_file_name: type: - string - number - integer - 'null' last_3_months_processing_statements: type: - array - 'null' items: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' business_identification_number: type: - string - number - integer - 'null' w_9_file_name: type: - string - number - integer - 'null' w_9_file_url: type: - string - number - integer - 'null' business_registration_certificate_file_name: type: - string - number - integer - 'null' business_registration_certificate_file_url: type: - string - number - integer - 'null' principal_address: $ref: '#/components/schemas/OnboardingEntityAddressRequest' registered_address: $ref: '#/components/schemas/OnboardingEntityAddressRequest' additionalProperties: $ref: '#/components/schemas/JsonValue' OnboardingMeta: type: object required: - request_id - timestamp properties: request_id: type: - string - 'null' timestamp: type: string format: date-time additionalProperties: $ref: '#/components/schemas/JsonValue' UnauthorizedResponse: type: object properties: message: type: string required: - message 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/OnboardingMeta' additionalProperties: $ref: '#/components/schemas/JsonValue' OnboardingUpdateCompanyEntityRequest: description: >- Entity attributes accepted when updating one. `draft` and `archived` both take the entity out of service and run the same reference guards, so either one is refused with 422 while the entity is still the company default, still holds live payment accounts, or still has countries assigned. allOf: - $ref: '#/components/schemas/OnboardingCompanyEntityRequest' - type: object properties: status: description: >- Lifecycle state to move the entity into. Omit it to leave the entity where it is; a null is refused with 422 rather than read as no change. type: string enum: - draft - active - inactive - archived 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' OnboardingEntityAddressRequest: type: - object - 'null' properties: address1: type: - string - number - integer - 'null' address2: type: - string - number - integer - 'null' address3: type: - string - number - integer - 'null' city: type: - string - number - integer - 'null' state: type: - string - number - integer - 'null' postal_code: type: - string - number - integer - 'null' country_code: type: - string - number - integer - 'null' 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' OnboardingCompanyEntityRequest: type: - object - 'null' properties: legal_name: type: - string - number - integer - 'null' classification: type: - string - number - integer - 'null' trading_name: type: - string - number - integer - 'null' country_iso: type: - string - number - integer - 'null' address1: type: - string - number - integer - 'null' address2: type: - string - number - integer - 'null' city: type: - string - number - integer - 'null' province: type: - string - number - integer - 'null' postal_code: type: - string - number - integer - 'null' registration_number: type: - string - number - integer - 'null' date_of_incorporation: type: - string - number - integer - 'null' primary_mcc: type: - integer - string - number - 'null' secondary_mcc: type: - integer - string - number - 'null' phone_country_code: type: - string - number - integer - 'null' phone: type: - string - number - integer - 'null' website: type: - string - number - integer - 'null' tax_id: type: - string - number - integer - 'null' billing_descriptor: description: >- Card-statement descriptor for this legal entity, shown to customers in billing disclosures. Display only, never sent to the payment processor. Allows letters, numbers, spaces and the characters & , . ' # * and -, up to 22 characters. Surrounding whitespace is trimmed on save, so the limit is measured against what you submit. Send null or an empty string to clear it. type: - string - 'null' maxLength: 22 pattern: ^[a-zA-Z0-9 &,.'#*-]*$ principal_same_as_registered_address: type: - boolean - 'null' primary: type: - boolean - 'null' business_registration_file_url: type: - string - number - integer - 'null' business_registration_file_name: type: - string - number - integer - 'null' business_license_file_url: type: - string - number - integer - 'null' business_license_file_name: type: - string - number - integer - 'null' articles_of_incorporation_file_url: type: - string - number - integer - 'null' articles_of_incorporation_file_name: type: - string - number - integer - 'null' last_3_months_processing_statements: type: - array - 'null' items: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' business_identification_number: type: - string - number - integer - 'null' w_9_file_name: type: - string - number - integer - 'null' w_9_file_url: type: - string - number - integer - 'null' business_registration_certificate_file_name: type: - string - number - integer - 'null' business_registration_certificate_file_url: type: - string - number - integer - 'null' principal_address: $ref: '#/components/schemas/OnboardingEntityAddressRequest' registered_address: $ref: '#/components/schemas/OnboardingEntityAddressRequest' 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.