> ## 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. # Pay the overdrawn credit balance now > Charges the saved card or bank account for what the credit balance is overdrawn by, now instead of at the next billing run: at least the rail's smallest charge, any surplus added as credits, and no auto-reload top-up. Only for a company whose billing is paid from credits. It is the merchant's own charge, so it works while automatic charges are blocked: a success lifts that block, a failure keeps it. A declined card returns the charge as failed, with its reason (201). Takes no body and no key. Only one charge runs at a time: while one is on its way a repeat is refused (409), and once the debt is paid a repeat finds nothing owed (422); neither charges. Needs billing.update; never a Droplet token. ## OpenAPI ````yaml /api-reference/settings-v0.yaml post /api/settings/billing/credits/pay-now 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/credits/pay-now: post: tags: - billing summary: Pay the overdrawn credit balance now description: >- Charges the saved card or bank account for what the credit balance is overdrawn by, now instead of at the next billing run: at least the rail's smallest charge, any surplus added as credits, and no auto-reload top-up. Only for a company whose billing is paid from credits. It is the merchant's own charge, so it works while automatic charges are blocked: a success lifts that block, a failure keeps it. A declined card returns the charge as failed, with its reason (201). Takes no body and no key. Only one charge runs at a time: while one is on its way a repeat is refused (409), and once the debt is paid a repeat finds nothing owed (422); neither charges. Needs billing.update; never a Droplet token. operationId: settings_v0_create_billing_credit_debt_payment responses: '201': description: >- The charge was reserved and sent; its status says where the payment stands content: application/json: schema: $ref: '#/components/schemas/BillingCreditPayNowResponse' example: credit_purchase: id: 7391 origin: settlement status: succeeded instrument_type: card failure_message: null invoice_available: false top_up_cents: 0 amount_cents: 100000 bonus_percent: 0 bonus_cents: 0 credit_cents: 100000 refunded_cents: 0 credits_expire_at: '2027-09-30T14:05:11Z' created_at: '2026-09-30T14:05:09Z' succeeded_at: '2026-09-30T14:05:11Z' failed_at: null balance_cents: 0 status: 201 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 permission, not an admin, or a Droplet token content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '404': description: The company's billing is not paid from credits (not_credit_billed) content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '409': description: A charge is already on its way (in_flight); nothing was charged content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '422': description: >- Nothing is owed (no_debt), or the saved payment method cannot be charged (no_profile, not_active, not_auto_debit, no_instrument, no_mandate, instrument_mode_mismatch) content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '503': description: >- Payments are unavailable (purchase_unavailable). Nothing was charged and nothing sends the charge again: the attempt is recorded as a failed purchase (provider_unconfigured). Pay again when payments return, or the next billing run charges the debt content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: BillingCreditPayNowResponse: type: object description: The charge Pay now made. required: - credit_purchase - balance_cents properties: credit_purchase: $ref: '#/components/schemas/BillingCreditPurchase' balance_cents: type: integer description: The credit balance after the charge in cents. Still below zero while a bank payment settles.: null 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' BillingCreditPurchase: type: object description: >- One purchase of credits: what was paid, what it granted, and where its money stands. succeeded means the credits were granted; processing means the payment is still settling. origin is manual (the merchant bought), auto_reload (a low balance bought), or settlement (a charge for what a credit-billed company owes, with any auto-reload top-up). required: - id - origin - status - instrument_type - failure_message - invoice_available - top_up_cents - amount_cents - bonus_percent - bonus_cents - credit_cents - refunded_cents - credits_expire_at - created_at - succeeded_at - failed_at properties: id: type: integer origin: type: string enum: - manual - auto_reload - settlement - plan description: >- How the purchase began: manual, auto_reload, settlement (a charge for what the company owes), or plan (the monthly plan charge). status: type: string enum: - pending - processing - succeeded - failed - refunded - reversed instrument_type: type: string enum: - card - us_bank_account failure_message: type: - string - 'null' description: Why the payment failed for a failed purchase.: null top_up_cents: type: - integer - 'null' minimum: 0 description: >- For a settlement, the part of amount_cents that is the auto-reload top-up; the rest paid the debt and any surplus up to the rail's smallest charge. Null for every other origin. invoice_available: type: boolean description: >- Whether the purchase has a paid Stripe invoice to open; GET /api/settings/billing/credits/purchases/{id}/invoice returns its link. amount_cents: type: integer minimum: 1 description: What was paid in cents.: null bonus_percent: type: integer minimum: 0 maximum: 100 bonus_cents: type: integer minimum: 0 credit_cents: type: integer minimum: 1 description: Every credit the purchase grants bonus included.: null refunded_cents: type: integer minimum: 0 description: What Fluid refunded in cents.: null credits_expire_at: type: string format: date-time created_at: type: string format: date-time succeeded_at: type: - string - 'null' format: date-time failed_at: type: - string - 'null' 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' 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 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.