> ## 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, run `fluid signup` from the Fluid CLI, or 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. # Give up a waiting card purchase > Cancels the PaymentIntent of a card purchase that is waiting for its cardholder to confirm it with their bank, and closes the purchase as failed (failure_message says the card was not confirmed). Nothing was charged, no automatic charge is blocked, and the merchant can buy or pay again at once. If the cardholder finished confirming first, the purchase is settled instead and comes back succeeded. A purchase that is not waiting comes back as it stands. A wait the merchant does not end is ended by Fluid after about 15 to 30 minutes. Needs billing.update; never a Droplet token. ## OpenAPI ````yaml /api-reference/settings-v0.yaml delete /api/settings/billing/credits/purchases/{id}/authentication openapi: 3.1.0 info: title: Fluid Settings 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/settings/billing/credits/purchases/{id}/authentication: delete: tags: - billing summary: Give up a waiting card purchase description: >- Cancels the PaymentIntent of a card purchase that is waiting for its cardholder to confirm it with their bank, and closes the purchase as failed (failure_message says the card was not confirmed). Nothing was charged, no automatic charge is blocked, and the merchant can buy or pay again at once. If the cardholder finished confirming first, the purchase is settled instead and comes back succeeded. A purchase that is not waiting comes back as it stands. A wait the merchant does not end is ended by Fluid after about 15 to 30 minutes. Needs billing.update; never a Droplet token. operationId: settings_v0_delete_billing_credit_purchase_authentication parameters: - name: id in: path required: true description: The credit purchase's id. schema: type: integer responses: '200': description: The purchase as it stands now content: application/json: schema: $ref: '#/components/schemas/BillingCreditPurchaseStateResponse' example: credit_purchase: id: 7343 origin: manual status: failed instrument_type: card failure_message: The card was not confirmed in time. Nothing was charged. invoice_available: false action_required: false top_up_cents: null amount_cents: 100000 bonus_percent: 10 bonus_cents: 10000 credit_cents: 110000 surcharge_cents: 0 total_cents: 100000 refunded_cents: 0 credits_expire_at: '2027-09-12T16:20:05Z' created_at: '2026-09-12T16:19:58Z' succeeded_at: null failed_at: '2026-09-12T16:24:40Z' balance_cents: 75500 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 permission, not an admin, or a Droplet token content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '404': description: No such purchase for the company content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '409': description: >- Stripe would not cancel the payment and it is not finished either (not_released); try again content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '503': description: >- Stripe could not be reached (provider_unavailable); the purchase is still waiting, try again content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: BillingCreditPurchaseStateResponse: type: object description: A credit purchase as it stands, with the credit balance. required: - credit_purchase - balance_cents properties: credit_purchase: $ref: '#/components/schemas/BillingCreditPurchase' balance_cents: type: integer description: The credit balance now in cents.: 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 - action_required - top_up_cents - amount_cents - bonus_percent - bonus_cents - credit_cents - surcharge_cents - total_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, for older charges raised to a rail minimum, may include surplus added to credits. 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. action_required: type: boolean description: >- Whether a card purchase is waiting for its cardholder to confirm it with their bank (3D Secure). Nothing is charged until they do. The response that made the purchase carries next_action; GET /api/settings/billing/credits/purchases/{id}/authentication returns it again and DELETE gives the wait up. status is processing while it waits. amount_cents: type: integer minimum: 1 description: What was paid in cents.: null bonus_percent: type: number minimum: 0 maximum: 100 description: The bonus, in percent, to at most two decimal places. bonus_cents: type: integer minimum: 0 credit_cents: type: integer minimum: 1 description: Every credit the purchase grants bonus included.: null surcharge_cents: type: integer minimum: 0 description: The processing fee charged on top of amount_cents in cents; 0 when none.: null total_cents: type: integer minimum: 1 description: What the payment method was charged amount_cents plus surcharge_cents.: null refunded_cents: type: integer minimum: 0 description: What Fluid refunded to the payment method in cents: null its share of the fee included.: 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.