> ## 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. # Buy credits with the saved card or bank account > Charges the company's saved card or bank account off-session and grants the credits, and the bonus its tier gives, once Stripe reports the money received: at once for a card that succeeds, else when the payment settles. The server prices every purchase: expected_credit_cents must equal what it quotes, and terms_version the terms in force, or nothing is charged (409). A repeat of the same purchase_key charges once and returns the first purchase (200). A declined card returns the purchase as failed with its reason. Needs billing.update; never a Droplet token. ## OpenAPI ````yaml /api-reference/settings-v0.yaml post /api/settings/billing/credits/purchases 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/purchases: post: tags: - billing summary: Buy credits with the saved card or bank account description: >- Charges the company's saved card or bank account off-session and grants the credits, and the bonus its tier gives, once Stripe reports the money received: at once for a card that succeeds, else when the payment settles. The server prices every purchase: expected_credit_cents must equal what it quotes, and terms_version the terms in force, or nothing is charged (409). A repeat of the same purchase_key charges once and returns the first purchase (200). A declined card returns the purchase as failed with its reason. Needs billing.update; never a Droplet token. operationId: settings_v0_create_billing_credit_purchase requestBody: required: true content: application/json: schema: type: object additionalProperties: false required: - amount_cents - expected_credit_cents - purchase_key - terms_version properties: amount_cents: type: integer minimum: 1 description: What to pay in cents; whole dollars within the company's purchase limits.: null expected_credit_cents: type: integer minimum: 1 description: The credits the page quoted bonus included: null in cents.: null purchase_key: type: string format: uuid description: Caller-supplied UUID naming this purchase so a retry charges once.: null terms_version: type: string description: The purchase terms version shown before Buy. example: amount_cents: 100000 expected_credit_cents: 110000 purchase_key: 3f7a2c91-8e4d-4b6a-9c15-e2d8b0f47a36 terms_version: '2026-09-26' responses: '200': description: A repeat of the purchase key; the first purchase content: application/json: schema: $ref: '#/components/schemas/BillingCreditPurchaseResponse' example: credit_purchase: id: 7342 origin: manual status: succeeded instrument_type: card failure_message: null amount_cents: 100000 bonus_percent: 10 bonus_cents: 10000 credit_cents: 110000 refunded_cents: 0 credits_expire_at: '2027-09-12T16:20:05Z' created_at: '2026-09-12T16:19:58Z' succeeded_at: '2026-09-12T16:20:05Z' failed_at: null balance_cents: 185500 duplicate: true status: 200 meta: request_id: f3b8c2d1-6a4e-4f7b-9c1d-2e5a8b7c4d90 timestamp: '2026-09-30T14:05:11Z' '201': description: The purchase was made; its status says where the payment stands content: application/json: schema: $ref: '#/components/schemas/BillingCreditPurchaseResponse' example: credit_purchase: id: 7342 origin: manual status: succeeded instrument_type: card failure_message: null amount_cents: 100000 bonus_percent: 10 bonus_cents: 10000 credit_cents: 110000 refunded_cents: 0 credits_expire_at: '2027-09-12T16:20:05Z' created_at: '2026-09-12T16:19:58Z' succeeded_at: '2026-09-12T16:20:05Z' failed_at: null balance_cents: 185500 duplicate: false 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' '409': description: >- The quote or the purchase terms changed since the page showed them (quote_changed, terms_changed), or an earlier purchase still has no answer (purchase_unanswered); nothing was charged content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '422': description: >- The purchase is invalid, the key was used for another purchase, or the company cannot buy credits now (no usable card or bank account) content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '503': description: >- Payments are unavailable. A new purchase was not charged; a retry of a purchase already sent stays pending, so keep its purchase_key and check the purchase before buying again content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: BillingCreditPurchaseResponse: type: object required: - credit_purchase - balance_cents - duplicate properties: credit_purchase: $ref: '#/components/schemas/BillingCreditPurchase' balance_cents: type: integer description: The credit balance after the purchase in cents.: null duplicate: type: boolean description: Whether this returns a purchase already made with the same key. 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. required: - id - origin - status - instrument_type - failure_message - 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 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 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 ````