> ## 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. # List the changes to the company's credit balance > Every change to the authenticated company's credit balance, newest first, one cursor page at a time, with the balance after each. A promotional movement names no one and gives no reason. Reading changes nothing. ## OpenAPI ````yaml /api-reference/settings-v0.yaml get /api/settings/billing/credits/movements 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/movements: get: tags: - billing summary: List the changes to the company's credit balance description: >- Every change to the authenticated company's credit balance, newest first, one cursor page at a time, with the balance after each. A promotional movement names no one and gives no reason. Reading changes nothing. operationId: settings_v0_list_billing_credit_movements parameters: - name: page[cursor] in: query required: false description: The cursor of the page to read; left out is the newest page. schema: type: string - name: page[limit] in: query required: false description: Movements per page. schema: type: integer minimum: 1 maximum: 100 default: 25 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/BillingCreditMovementsResponse' example: credit_movements: - id: 5e0f4a9c-2d7b-4c61-8f3a-b19e7d6c2a58 kind: draw label: AI usage source: purchase amount_cents: -1250 balance_after_cents: 184250 category: ai usage_event_id: a8d3c6e1-4f2b-4b97-9e05-7c1a3d8f6b24 purchase_id: null occurred_at: '2026-09-29T19:48:33Z' - id: 0b9c7e3d-81a4-4f5e-a6d2-3c8e1f7b9a40 kind: grant label: Bonus credits source: bonus amount_cents: 10000 balance_after_cents: 185500 category: null usage_event_id: null purchase_id: 7342 occurred_at: '2026-09-12T16:20:05Z' - id: d2f6a8b1-3e7c-4a90-b5d4-6f1c9e2a7b83 kind: grant label: Credits purchased source: purchase amount_cents: 100000 balance_after_cents: 175500 category: null usage_event_id: null purchase_id: 7342 occurred_at: '2026-09-12T16:20:05Z' status: 200 meta: request_id: f3b8c2d1-6a4e-4f7b-9c1d-2e5a8b7c4d90 timestamp: '2026-09-30T14:05:11Z' pagination: cursor: null limit: 25 prev_cursor: null next_cursor: >- eyJvY2N1cnJlZF9hdCI6IjIwMjYtMDktMTJUMTY6MjA6MDVaIiwiaWQiOiJkMmY2YThiMSJ9 '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/StandardUnauthorizedResponse' '403': description: Missing billing.view permission, or a Droplet token content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '422': description: The page cursor or limit could not be read content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: BillingCreditMovementsResponse: type: object description: One page of credit movements, newest first. required: - credit_movements - meta properties: credit_movements: type: array items: $ref: '#/components/schemas/BillingCreditMovement' meta: type: object required: - pagination properties: pagination: $ref: '#/components/schemas/BillingCreditMovementPagination' 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' BillingCreditMovement: type: object description: >- One change to the credit balance. A promotional movement names no one and gives no reason. required: - id - kind - label - source - amount_cents - balance_after_cents - category - usage_event_id - purchase_id - occurred_at properties: id: type: string format: uuid description: The movement's id. kind: type: string enum: - grant - draw - overdraft_repayment - expiry - revocation - refund - reversal description: What changed the balance. label: type: string description: What the movement is called, such as Promotional credits. source: type: - string - 'null' enum: - purchase - bonus - promotional - plan - null description: Where the credits it changed came from when they share one source.: null amount_cents: type: integer description: Signed change to the balance in cents.: null balance_after_cents: type: integer description: The balance after the movement in cents.: null category: type: - string - 'null' description: For usage the kind of usage it paid for.: null usage_event_id: type: - string - 'null' format: uuid description: For usage the usage event it paid for.: null purchase_id: type: - integer - 'null' description: For a purchase its refund: null or its reversal: null the purchase.: null occurred_at: type: string format: date-time description: When the change took effect. BillingCreditMovementPagination: type: object required: - cursor - limit - prev_cursor - next_cursor properties: cursor: type: - string - 'null' description: This page's cursor. limit: type: integer description: Movements per page. prev_cursor: type: - string - 'null' description: The newer page's cursor or null.: null next_cursor: type: - string - 'null' description: The older page's cursor or null.: 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' 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 ````