> ## 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. # Subscription Billing month grid (scheduled, at risk, settled) > Returns one row per date in the requested month — what is scheduled to bill, how much of it is graded at risk, and what already settled — plus the previous month's totals for the month-over-month figure. Both months come from one service call over a single widened range, so the comparison cannot be assembled from two reads of different data. Two halves, two sources. Days still to come read `commerce_subscriptions.next_bill_date`, bucketed in the `tz` the operator is reading in (echoed back as `time_zone`). Days that have run read `commerce_billing_events`, whose `local_billed_date` is already local. Money is `price * quantity`, which is what a renewal charges. Note that the Home > Overview subscription-engine and payment-recovery cards still sum bare `price`, so they read low against this endpoint for any fleet carrying `quantity > 1` until that is corrected. Renewals are graded at risk by a deterministic read of dunning state — prior declines, hard declines, staleness, whether the retry chain has them in hand. No per-renewal likelihood is served; nothing in the platform produces one. ## OpenAPI ````yaml /api-reference/analytics-v2026-04.yaml get /api/v202604/analytics/subscription_billing/calendar openapi: 3.1.0 info: title: Fluid Analytics Dashboard v2026-04 API version: v2026-04 description: | Endpoints backing the fluid-admin Analytics section (Home / Traffic / Brand Buzz). One endpoint per card on each tab; the frontend polls independently so each card can have its own refresh cadence. 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: - bearer_auth: [] tags: - name: analytics_dashboard_home_overview description: | Home > Overview tab cards. Card 1 (header tiles) is served here; cards 2-11 land in subsequent PRs. - name: analytics_dashboard_home_live description: | Home > Live tab cards. Card 1 (header tiles) is served here; cards 2-6 land in subsequent PRs. - name: analytics_dashboard_home_field description: | Home > Field tab cards. Card 1 (field momentum header) is served here; cards 2-5 land in subsequent PRs. - name: analytics_subscription_billing description: | Subscription Billing surface — a month of renewals worked day by day, plus that month's failure reporting. Same `reports.view` gate and country scoping as the Home dashboard cards. The day drawer's per-subscription table is not served here; it is a paginated list on `GET /api/subscriptions`, which already accepts `next_bill_date` and `last_failed_at` range filters. paths: /api/v202604/analytics/subscription_billing/calendar: get: tags: - analytics_subscription_billing summary: Subscription Billing month grid (scheduled, at risk, settled) description: | Returns one row per date in the requested month — what is scheduled to bill, how much of it is graded at risk, and what already settled — plus the previous month's totals for the month-over-month figure. Both months come from one service call over a single widened range, so the comparison cannot be assembled from two reads of different data. Two halves, two sources. Days still to come read `commerce_subscriptions.next_bill_date`, bucketed in the `tz` the operator is reading in (echoed back as `time_zone`). Days that have run read `commerce_billing_events`, whose `local_billed_date` is already local. Money is `price * quantity`, which is what a renewal charges. Note that the Home > Overview subscription-engine and payment-recovery cards still sum bare `price`, so they read low against this endpoint for any fleet carrying `quantity > 1` until that is corrected. Renewals are graded at risk by a deterministic read of dunning state — prior declines, hard declines, staleness, whether the retry chain has them in hand. No per-renewal likelihood is served; nothing in the platform produces one. operationId: getAnalyticsSubscriptionBillingCalendar parameters: - $ref: '#/components/parameters/MonthQueryParam' - $ref: '#/components/parameters/CountryQueryParam' - $ref: '#/components/parameters/TimeZoneQueryParam' responses: '200': description: Month grid payload content: application/json: schema: $ref: '#/components/schemas/SubscriptionBillingCalendarResponse' '400': $ref: '#/components/responses/InvalidRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/Unprocessable' components: parameters: MonthQueryParam: name: month in: query required: false description: | Calendar month to report on, as `YYYY-MM`. Defaults to the current month. A value that is not this exact shape (or names a month that does not exist, such as `2026-13`) returns `400` rather than being coerced. schema: type: string pattern: ^\d{4}-\d{2}$ example: 2026-09 CountryQueryParam: name: country in: query required: false description: | ISO alpha-2 code of one of the requesting company's configured countries (see `GET /countries`). When present, every service on this endpoint filters its data to that country and reports money in the country's own currency. Omit (or send `"all"`) for the aggregate-across-countries view, which is the default and matches pre-Phase-004 behavior. Unknown ISO codes or ones the company is not configured for return `400`. schema: type: string example: US TimeZoneQueryParam: name: tz in: query required: false description: | IANA timezone name (e.g. `America/Denver`) or Rails-style alias (`Eastern Time (US & Canada)`) used to anchor "today" boundaries and hour-of-day bucketing. The frontend sends `Intl.DateTimeFormat().resolvedOptions().timeZone`. Unknown or malformed values silently fall back to UTC — callers omit the param when the endpoint doesn't need wall-clock alignment (see CURRENT-3077). schema: type: string example: America/Denver schemas: SubscriptionBillingCalendarResponse: type: object properties: month: type: string format: date description: First of the month reported. example: '2026-09-01' time_zone: type: string description: | IANA zone the scheduled half was bucketed in — the `tz` that was sent, or `UTC` when it was missing or unknown. Echoed so the grid can label which day boundaries it is drawing. The settled half needs no such note: billing events carry an already-local date. example: America/Denver currency: $ref: '#/components/schemas/Currency' days: type: array description: | One entry per date in the month, ascending, always the full month. A quiet month returns zero-filled days rather than an empty array, so the grid can tell "nothing happened" from "nothing loaded". items: $ref: '#/components/schemas/SubscriptionBillingDay' totals: $ref: '#/components/schemas/SubscriptionBillingTotals' previous_totals: $ref: '#/components/schemas/SubscriptionBillingTotals' required: - month - time_zone - currency - days - totals - previous_totals Currency: type: string description: ISO 4217 three-letter code (uppercase). example: USD minLength: 3 maxLength: 3 SubscriptionBillingDay: type: object description: | One cell in the month grid. Scheduled and settled figures are kept apart rather than flattened: `scheduled_amount` only means something before a day's charges run, `succeeded_amount` only after. A day that is part-way through carries both. properties: date: type: string format: date example: '2026-09-20' scheduled_count: type: integer minimum: 0 description: | Renewals due on this date that automatic billing will still claim. scheduled_amount: $ref: '#/components/schemas/Money' overdue_count: type: integer minimum: 0 description: | Renewals due on this date but aged past `Commerce::Subscription::OVERDUE_LOOKBACK`. Automatic billing never claims these, so they are reported apart from scheduled money rather than as revenue to come. overdue_amount: $ref: '#/components/schemas/Money' at_risk_count: type: integer minimum: 0 description: | Scheduled renewals graded `elevated` or `severe`. The grade is a deterministic read of present dunning state, not a predicted likelihood — no per-renewal score is served. at_risk_amount: $ref: '#/components/schemas/Money' top_risk_driver: type: - string - 'null' description: | The most common risk factor behind the day's at-risk renewals, or `null` when none are graded. enum: - disabled - hard_decline - stale_failure - repeated_declines - dunning_in_flight - prior_failures - null example: prior_failures in_flight_count: type: integer minimum: 0 description: | Billing events staged or attempted but not yet resolved. Counted rather than summed, and excluded from both the scheduled and settled totals, so nothing is silently dropped between the two halves of the day. succeeded_count: type: integer minimum: 0 succeeded_amount: $ref: '#/components/schemas/Money' hard_decline_count: type: integer minimum: 0 description: | Failures whose event is not retriable under `Commerce::BillingEvent.retriable_failure?` — the dunning chain will not attempt these again. hard_decline_amount: $ref: '#/components/schemas/Money' soft_decline_count: type: integer minimum: 0 description: | Retriable failures that nothing currently has in hand. soft_decline_amount: $ref: '#/components/schemas/Money' awaiting_retry_count: type: integer minimum: 0 description: | Retriable failures whose subscription passes every gate `Commerce::RetryFailedPaymentsJob` applies, so a retry is scheduled. awaiting_retry_amount: $ref: '#/components/schemas/Money' required: - date - scheduled_count - scheduled_amount - overdue_count - overdue_amount - at_risk_count - at_risk_amount - top_risk_driver - in_flight_count - succeeded_count - succeeded_amount - hard_decline_count - hard_decline_amount - soft_decline_count - soft_decline_amount - awaiting_retry_count - awaiting_retry_amount SubscriptionBillingTotals: type: object description: | Month-level sums. `renewal_*` rolls scheduled and overdue together; the two questions differ, and a previous month is always read after its own overdue floor has passed, so a month-over-month comparison against `scheduled_*` alone would show nothing there. properties: scheduled_count: type: integer minimum: 0 scheduled_amount: $ref: '#/components/schemas/Money' overdue_count: type: integer minimum: 0 overdue_amount: $ref: '#/components/schemas/Money' renewal_count: type: integer minimum: 0 description: Every renewal that fell due, collectable or not. renewal_amount: $ref: '#/components/schemas/Money' succeeded_count: type: integer minimum: 0 succeeded_amount: $ref: '#/components/schemas/Money' failed_count: type: integer minimum: 0 failed_amount: $ref: '#/components/schemas/Money' required: - scheduled_count - scheduled_amount - overdue_count - overdue_amount - renewal_count - renewal_amount - succeeded_count - succeeded_amount - failed_count - failed_amount ErrorResponse: type: object properties: error: type: object properties: message: type: string details: type: object additionalProperties: true required: - message meta: $ref: '#/components/schemas/Meta' required: - error LegacyUnauthorizedResponse: type: object properties: message: type: string required: - message LegacyForbiddenResponse: type: object properties: message: type: string error: type: string minProperties: 1 Money: type: string description: | Decimal amount, expressed as a string to preserve arbitrary precision across the wire. Parsed to Number on the client and formatted with `Intl.NumberFormat`. Once the in-flight money-cents-migration lands, this will switch to a `{ amount_cents: integer, currency: string }` object. example: '180.25' Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time required: - timestamp responses: InvalidRequest: description: | A query parameter the endpoint cannot act on — a `country` the requesting company is not configured for, a `month` that is not `YYYY-MM`, or a `date` that is not `YYYY-MM-DD`. All are caller errors rather than scoping failures, and all render the structured error envelope. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: Missing or invalid bearer token content: application/json: schema: $ref: '#/components/schemas/LegacyUnauthorizedResponse' Forbidden: description: | Token present but the caller is not a company admin (or is one without `reports.view`). Both branches render via legacy `authorize_*` helpers whose response predates the structured error envelope, so the body is the flat legacy shape. content: application/json: schema: $ref: '#/components/schemas/LegacyForbiddenResponse' Unprocessable: description: An Analytics service returned a business-rule failure. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: bearer_auth: type: http scheme: bearer description: | Bearer token authentication. Requires a company-admin token whose role holds `reports.view`. ````