> ## 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. > 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/auth-v0.yaml covers the unversioned auth surface (/api/... paths — authentication, MFA, social auth, and token exchange); 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. # Schedule retries for a chosen time > Book a retry on each of a set of past-due subscriptions for a time the operator chose, for the Subscription Billing day drawer. The time is the operator's and only the operator's. Nothing in this platform scores when a charge is most likely to clear, so this endpoint neither picks the hour nor moves it: it writes the instant the caller sent. What it buys an operator is control over when a day's failed renewals are charged again — out of a payday window, off an hour that already declined — not a prediction. The retry processor drains bookings on its ordinary five-minute tick, so nothing is charged when this returns. `retry_at` must be at least 5 minutes ahead, and within 23 hours: past that the processor stops recognising the booking's provenance and would fall back to its automatic rules, which is a retry the operator did not ask for. Booking does not reset the subscription's decline count. An immediate retry does, because it is one hands-on attempt on one renewal; a booking is a batch gesture that can be repeated every morning, and resetting there would hold a subscription in dunning forever instead of letting it reach exhaustion. Every token is answered. A token is scheduled when a retry is now booked for it, skipped when the subscription is known but cannot take one — with the reason — or failed when no subscription of that token belongs to the caller. A skip is not an error: a renewal that is not past due, will not be due by the chosen time, or sits on a payment method the processor told us to stop charging is reported as passed over. Booking the same subscriptions for the same instant twice books one retry. Booking them for a different instant moves the existing booking, which is how a mistyped hour is corrected. ## OpenAPI ````yaml /api-reference/company-v0.yaml post /api/subscriptions/scheduled_retries openapi: 3.1.0 info: title: Fluid Company API version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app - url: https://{company}.fluid.app description: Production server with company subdomain variables: company: default: myco description: Company subdomain security: [] paths: /api/subscriptions/scheduled_retries: post: tags: - subscriptions summary: Schedule retries for a chosen time description: | Book a retry on each of a set of past-due subscriptions for a time the operator chose, for the Subscription Billing day drawer. The time is the operator's and only the operator's. Nothing in this platform scores when a charge is most likely to clear, so this endpoint neither picks the hour nor moves it: it writes the instant the caller sent. What it buys an operator is control over when a day's failed renewals are charged again — out of a payday window, off an hour that already declined — not a prediction. The retry processor drains bookings on its ordinary five-minute tick, so nothing is charged when this returns. `retry_at` must be at least 5 minutes ahead, and within 23 hours: past that the processor stops recognising the booking's provenance and would fall back to its automatic rules, which is a retry the operator did not ask for. Booking does not reset the subscription's decline count. An immediate retry does, because it is one hands-on attempt on one renewal; a booking is a batch gesture that can be repeated every morning, and resetting there would hold a subscription in dunning forever instead of letting it reach exhaustion. Every token is answered. A token is scheduled when a retry is now booked for it, skipped when the subscription is known but cannot take one — with the reason — or failed when no subscription of that token belongs to the caller. A skip is not an error: a renewal that is not past due, will not be due by the chosen time, or sits on a payment method the processor told us to stop charging is reported as passed over. Booking the same subscriptions for the same instant twice books one retry. Booking them for a different instant moves the existing booking, which is how a mistyped hour is corrected. operationId: commerce_v0_scheduled_retries requestBody: content: application/json: schema: $ref: '#/components/schemas/ScheduledRetriesRequestBody' required: true responses: '200': description: Every token answered as scheduled, skipped, or failed content: application/json: schema: $ref: '#/components/schemas/ScheduledRetriesResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/StandardUnauthorizedResponse' '403': description: > The caller lacks the subscriptions update permission, or is a customer. Booking a renewal's retry is a back-office action, not a shopper one. content: application/json: schema: $ref: '#/components/schemas/StandardForbiddenResponse' '422': description: > The batch was refused before any renewal was touched — no tokens, more tokens than one batch carries, a `retry_at` that is malformed, too soon, or too far out, or billing paused for the company. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: ScheduledRetriesRequestBody: description: The subscription tokens to book, and the time to book them for. type: object additionalProperties: false required: - tokens - retry_at properties: tokens: description: | Subscription tokens. The maximum counts the array as submitted, so `maxItems` and the server's own refusal agree; duplicates are collapsed after that bound is applied and each subscription is answered once. type: array minItems: 1 maxItems: 500 items: type: string example: - sb_primex_past_due_002 retry_at: description: | When to retry, as an RFC3339 timestamp carrying its offset. The offset is the caller's to state rather than the server's to guess: a bare local hour from a drawer open in one timezone is a different instant on a server running in another. The time is the operator's choice and nothing else. No model here scores when a charge is likeliest to clear, so the platform neither picks this hour nor adjusts it. At least 5 minutes ahead — anything nearer is an immediate retry, which has its own endpoint — and no more than 23 hours ahead, the span the retry processor still recognises an operator's booking over. type: string format: date-time example: '2026-09-15T18:00:00Z' ScheduledRetriesResponse: description: One entry per token sent, across three lists. type: object required: - retry_at - scheduled_tokens - skipped_tokens - failed_tokens - meta properties: retry_at: description: | The instant the batch was booked for, in UTC. Echoed so a client states the booked hour from the server's answer rather than from the value it happened to send. type: string format: date-time scheduled_tokens: description: Subscriptions a retry is now booked for. type: array items: type: string skipped_tokens: description: Subscriptions passed over, each carrying why. type: array items: $ref: '#/components/schemas/ScheduledRetriesSkippedToken' failed_tokens: description: | Tokens that resolved to no subscription of the caller's, and subscriptions whose booking write was refused. type: array items: $ref: '#/components/schemas/ScheduledRetriesFailedToken' meta: $ref: '#/components/schemas/Meta' StandardUnauthorizedResponse: description: Common legacy unauthorized response envelope. allOf: - $ref: '#/components/schemas/StandardErrorResponse' StandardForbiddenResponse: description: Common legacy forbidden 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' ScheduledRetriesSkippedToken: description: A subscription that was found but could not be booked. type: object additionalProperties: false required: - token - reason - error properties: token: type: string description: The subscription token. reason: type: string description: Why the booking was passed over. enum: - not_past_due - billing_date_not_arrived - billing_cycle_limit - recurring_payment_stopped error: type: string description: The same reason, phrased for an operator to read. ScheduledRetriesFailedToken: description: | A token that ends with nothing booked: one no subscription of the caller's answers to, or one whose booking the write refused. type: object additionalProperties: false required: - token - error properties: token: type: string description: The token as it was sent. error: type: string description: Why nothing is booked for it. Meta: type: - object - 'null' properties: request_id: type: - string - number - integer - 'null' timestamp: type: - string - number - integer - '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' 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 ````