> ## 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. > 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. /api/company/v1 and /api/v1/... paths are documented in no spec here and must never be used (/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. # Set the company's spend limits > Sets some or all of the authenticated company's monthly spend limits and auto-reload; anything left out keeps its value, and a null limit is no limit. Turning auto-reload on records the merchant's consent to the authorization version sent; turning it off withdraws it. ## OpenAPI ````yaml /api-reference/settings-v0.yaml patch /api/settings/billing/usage-controls openapi: 3.1.0 info: title: Fluid Settings API version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] paths: /api/settings/billing/usage-controls: patch: tags: - billing summary: Set the company's spend limits description: >- Sets some or all of the authenticated company's monthly spend limits and auto-reload; anything left out keeps its value, and a null limit is no limit. Turning auto-reload on records the merchant's consent to the authorization version sent; turning it off withdraws it. operationId: settings_v0_update_billing_usage_controls requestBody: required: true content: application/json: schema: type: object properties: limits_enabled: type: boolean description: Whether the monthly spend limits are on. auto_reload: type: boolean description: >- Whether a low balance reloads itself; turning it on needs reload_authorization_version. reload_authorization_version: type: string description: >- The auto-reload authorization version the merchant was shown and accepts. auto_reload_threshold_cents: type: - integer - 'null' minimum: 1 description: Reload below this spendable balance in whole dollars of cents; null is Fluid's default.: null auto_reload_amount_cents: type: - integer - 'null' minimum: 1 description: What one reload buys in whole dollars of cents within the purchase limits; null is Fluid's default.: null orders_limit_cents: type: - integer - 'null' minimum: 1 description: Orders and checkout; notified never stopped.: null ai_limit_cents: type: - integer - 'null' minimum: 1 description: Monthly ceiling on AI in cents.: null hosting_limit_cents: type: - integer - 'null' minimum: 1 description: Apps hosting and media; notified: null never stopped.: null studios_limit_cents: type: - integer - 'null' minimum: 1 description: Monthly ceiling on Fluid Studios in cents.: null ai_daily_limit_cents: type: - integer - 'null' minimum: 1 description: Daily ceiling on AI in cents.: null studios_daily_limit_cents: type: - integer - 'null' minimum: 1 description: Daily ceiling on Fluid Studios in cents.: null auto_reload_daily_cap_cents: type: - integer - 'null' minimum: 1 description: >- The most auto-reload tops up in a day; null is Fluid's default. auto_reload_monthly_cap_cents: type: - integer - 'null' minimum: 1 description: >- The most auto-reload tops up in a month; null is Fluid's default. example: limits_enabled: true ai_limit_cents: 150000 studios_limit_cents: 75000 ai_daily_limit_cents: 10000 auto_reload: true reload_authorization_version: '2026-09-26' auto_reload_threshold_cents: 5000 auto_reload_amount_cents: 20000 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BillingUsageControlsResponse' example: usage_controls: limits_enabled: true auto_reload: true reload_caps: daily_cents: 50000 monthly_cents: 500000 limits: orders: null ai: 150000 hosting: null studios: 75000 daily_limits: ai: 10000 studios: null reload_threshold_cents: 5000 reload_amount_cents: 20000 reload_authorized: true reload_authorization: version: '2026-09-26' text: >- You authorize Fluid to charge the card or debit the bank account on file for the reload amount you set whenever your usage credits fall below your threshold, up to your daily and monthly reload limits. Each reload is a purchase of usage credits on the purchase terms. You can turn auto-reload off at any time. A declined or returned reload pauses further reloads until you change your payment method or turn auto-reload off and on again. reload_block: null status: 200 meta: request_id: f3b8c2d1-6a4e-4f7b-9c1d-2e5a8b7c4d90 timestamp: '2026-09-30T14:05:11Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/StandardUnauthorizedResponse' '403': description: >- Missing billing.update or billing.view permission, or a Droplet token content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '422': description: >- A limit was not a positive whole number of cents, the reload figures are outside the purchase limits, or auto-reload was turned on without the authorization in force (authorization_required) content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: BillingUsageControlsResponse: type: object description: The merchant's spend limits and auto-reload. required: - usage_controls properties: usage_controls: $ref: '#/components/schemas/BillingUsageControls' 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' BillingUsageControls: type: object description: >- What the merchant has set about its own usage: spend limits, and auto-reload, which buys the reload amount with the payment method on file when the spendable balance falls below the threshold, within the reload caps, and only with its authorization on record. required: - limits_enabled - auto_reload - reload_caps - limits - daily_limits - reload_threshold_cents - reload_amount_cents - reload_authorized - reload_authorization - reload_block properties: limits_enabled: type: boolean description: Whether the monthly spend limits are on. auto_reload: type: boolean description: >- Whether a low balance reloads itself. Never true without the authorization on record. reload_threshold_cents: type: integer minimum: 1 description: The spendable balance below which a reload is bought in cents.: null reload_amount_cents: type: integer minimum: 1 description: What one reload buys in cents.: null reload_authorized: type: boolean description: Whether the merchant's auto-reload authorization is on record. reload_authorization: type: object description: The authorization in force, shown before auto-reload is turned on. required: - version - text properties: version: type: string text: type: string reload_block: description: >- Set when a reload failed; nothing reloads until the payment method changes or auto-reload is turned off and on. oneOf: - type: object required: - reason - blocked_at properties: reason: type: string blocked_at: type: string format: date-time - type: 'null' reload_caps: type: object description: >- The most auto-reload tops up by, the company's own or Fluid's default; it is never uncapped. required: - daily_cents - monthly_cents properties: daily_cents: type: integer minimum: 1 description: The most it tops up in a day in cents.: null monthly_cents: type: integer minimum: 1 description: The most it tops up in a month in cents.: null limits: type: object description: >- Monthly limit per kind of usage, in cents; null is no limit. Orders and hosting always stay on, so a limit on either only notifies. required: - orders - ai - hosting - studios properties: orders: type: - integer - 'null' minimum: 1 description: Orders and checkout. ai: type: - integer - 'null' minimum: 1 description: AI. hosting: type: - integer - 'null' minimum: 1 description: Apps hosting and media.: null studios: type: - integer - 'null' minimum: 1 description: Fluid Studios. daily_limits: type: object description: >- Daily limit, in cents, for the kinds of usage a limit can pause; null is no daily limit. required: - ai - studios properties: ai: type: - integer - 'null' minimum: 1 description: AI. studios: type: - integer - 'null' minimum: 1 description: Fluid Studios. 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' Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time 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 ````