> ## 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. 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. # Report the company's milestone items > The milestone grant ledger for grants written in a range of days (UTC; a grant is written when it comes due): counts by status, source, deferral reason and rule, the substitutions, and one cursor page of the grants, newest first. Statuses are the grants' statuses now, so a grant deferred once and delivered later counts as fulfilled. Needs the milestone_items feature to work for the company. Reading changes nothing. Responses are not cached. ## OpenAPI ````yaml /api-reference/settings-v0.yaml get /api/subscription_pro/milestone_report 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/subscription_pro/milestone_report: get: tags: - subscription-pro summary: Report the company's milestone items description: >- The milestone grant ledger for grants written in a range of days (UTC; a grant is written when it comes due): counts by status, source, deferral reason and rule, the substitutions, and one cursor page of the grants, newest first. Statuses are the grants' statuses now, so a grant deferred once and delivered later counts as fulfilled. Needs the milestone_items feature to work for the company. Reading changes nothing. Responses are not cached. operationId: settings_v0_get_subscription_pro_milestone_report parameters: - name: from in: query required: false description: The first day (UTC). Defaults to 29 days before to. schema: type: string format: date - name: to in: query required: false description: >- The last day (UTC), inclusive. Defaults to today. At most 365 days after from, so the range covers at most 366 days. schema: type: string format: date - name: rule_id in: query required: false description: Only the grants of this rule. schema: type: integer - name: status in: query required: false schema: type: string enum: - planned - on_order - fulfilled - deferred - skipped_out_of_stock - voided - name: source in: query required: false schema: type: string enum: - rule - manual - retention_offer - 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: Grants per page. schema: type: integer minimum: 1 maximum: 100 default: 25 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/SubscriptionProMilestoneReportResponse' example: milestone_report: from: '2026-10-01' to: '2026-10-31' summary: total: 3 by_status: planned: 1 on_order: 0 fulfilled: 1 deferred: 0 skipped_out_of_stock: 1 voided: 0 by_source: rule: 2 manual: 1 retention_offer: 0 deferred_by_reason: gate_closed: 0 out_of_stock: 0 substitutions: 1 by_rule: - rule_id: 41 rule_name: Anniversary watch total: 2 by_status: planned: 0 on_order: 0 fulfilled: 1 deferred: 0 skipped_out_of_stock: 1 voided: 0 substitutions: 1 grants: - id: 5523 subscription_token: sb_8f2c1d9e7a source: rule status: fulfilled deferral_reason: null rule_id: 41 rule_name: Anniversary watch occurrence_key: anniversary:1 item_key: 3f1c2a9e-5b7d-4e8f-9a1b-2c3d4e5f6a7b variant_id: 9013 variant_title: Classic Watch, silver main_variant_id: 9012 substituted: true quantity: 1 unit_price: '0.00' currency_code: USD volume_policy: zero removable: false order_id: 771204 created_at: '2026-10-03T06:00:12Z' updated_at: '2026-10-03T06:02:40Z' status: 200 meta: pagination: cursor: null limit: 25 prev_cursor: null next_cursor: null '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/StandardUnauthorizedResponse' '403': description: >- Not an admin, missing the orders.settings or subscriptions.view permission (a role needs both), a droplet without both the settings and orders scopes (orders covers subscription reads), or the milestone_items feature does not work for the company. A closed feature names the failed check in error.details.error: subscription_pro_inactive, release_flag_unavailable, release_flag_off, setting_off or legacy_renewal_lane. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' '422': description: >- Invalid filters, a range of more than 366 days or ending before it starts, or an invalid cursor. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' security: - bearer_auth: [] components: schemas: SubscriptionProMilestoneReportResponse: type: object additionalProperties: false required: - milestone_report - status - meta properties: milestone_report: $ref: '#/components/schemas/SubscriptionProMilestoneReport' status: type: integer enum: - 200 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' SubscriptionProMilestoneReport: type: object additionalProperties: false required: - from - to - summary - grants properties: from: type: string format: date description: The first day of the range (UTC). to: type: string format: date description: The last day of the range (UTC) inclusive.: null summary: type: object additionalProperties: false description: >- Counts over every grant in the range and filters, not only this page. required: - total - by_status - by_source - deferred_by_reason - substitutions - by_rule properties: total: type: integer minimum: 0 by_status: $ref: '#/components/schemas/SubscriptionProMilestoneStatusCounts' by_source: type: object additionalProperties: false required: - rule - manual - retention_offer properties: rule: type: integer minimum: 0 manual: type: integer minimum: 0 retention_offer: type: integer minimum: 0 deferred_by_reason: type: object additionalProperties: false required: - gate_closed - out_of_stock properties: gate_closed: type: integer minimum: 0 out_of_stock: type: integer minimum: 0 substitutions: type: integer minimum: 0 description: Rule grants a fallback variant stood in for. by_rule: type: array description: Each rule with grants in the range, by rule id. items: type: object additionalProperties: false required: - rule_id - rule_name - total - by_status - substitutions properties: rule_id: type: integer rule_name: type: string total: type: integer minimum: 0 by_status: $ref: '#/components/schemas/SubscriptionProMilestoneStatusCounts' substitutions: type: integer minimum: 0 grants: type: array description: One page of the grants, newest first. items: $ref: '#/components/schemas/SubscriptionProMilestoneGrant' 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' SubscriptionProMilestoneStatusCounts: description: Grants by their status now. type: object additionalProperties: false required: - planned - on_order - fulfilled - deferred - skipped_out_of_stock - voided properties: planned: type: integer minimum: 0 on_order: type: integer minimum: 0 fulfilled: type: integer minimum: 0 deferred: type: integer minimum: 0 skipped_out_of_stock: type: integer minimum: 0 voided: type: integer minimum: 0 SubscriptionProMilestoneGrant: description: One milestone grant from the ledger. type: object additionalProperties: false required: - id - subscription_token - source - status - deferral_reason - rule_id - rule_name - occurrence_key - item_key - variant_id - variant_title - main_variant_id - substituted - quantity - unit_price - currency_code - volume_policy - removable - order_id - created_at - updated_at properties: id: type: integer subscription_token: type: string source: type: string enum: - rule - manual - retention_offer description: >- rule for a milestone rule's gift, manual for a one-time item an admin added. status: type: string enum: - planned - on_order - fulfilled - deferred - skipped_out_of_stock - voided description: >- planned and deferred are owed to a coming order. on_order is on an unpaid order. fulfilled is on a paid order. skipped_out_of_stock and voided are final. deferral_reason: type: - string - 'null' enum: - gate_closed - out_of_stock - null description: Why a deferred item moved to the next order. Null unless deferred. rule_id: type: - integer - 'null' description: The milestone rule, or null for a one-time item. rule_name: type: - string - 'null' occurrence_key: type: string description: >- The occurrence the item is for, such as order:4, anniversary:1 or manual:. item_key: type: string variant_id: type: integer description: The variant planned or sent. variant_title: type: - string - 'null' main_variant_id: type: integer description: >- The variant the item was for; differs from variant_id when a fallback stood in. substituted: type: boolean description: Whether a fallback variant stood in for the main one. quantity: type: integer minimum: 1 unit_price: type: string description: >- The price of one unit, a decimal string in currency_code. 0 for a gift. currency_code: type: string description: The subscription's currency. volume_policy: type: string enum: - zero - catalog description: zero earns no CV or QV. catalog earns the variant's catalog volume. removable: type: boolean description: >- Whether an admin can remove the item now (a one-time item still owed, while no renewal is being built). order_id: type: - integer - 'null' description: The order that carries the item, once it is on one. created_at: type: string format: date-time description: When the item was planned. updated_at: type: string format: date-time 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.