> ## 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. # Retrieve a single company discount > Returns one of the company's discounts with its full configuration, eligibility rules, schedule, and usage count, including any customer emails uploaded by CSV. Requires a company admin Bearer token with coupons view permission. Returns 404 when the discount does not exist in the company. ## OpenAPI ````yaml /api-reference/admin-v2025-06.yaml get /api/v2025-06/discounts/{id} openapi: 3.1.0 info: title: Fluid Admin v2025-06 API version: v2025-06 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] paths: /api/v2025-06/discounts/{id}: get: tags: - discounts summary: Retrieve a single company discount description: >- Returns one of the company's discounts with its full configuration, eligibility rules, schedule, and usage count, including any customer emails uploaded by CSV. Requires a company admin Bearer token with coupons view permission. Returns 404 when the discount does not exist in the company. operationId: admin_v2025_06_discounts_get__discounts_get parameters: - name: id in: path required: true schema: type: string responses: '200': description: Success content: application/json: example: id: 5821 code: PAPERDAY10 name: PAPERDAY10 description: 10% off orders over $50 for National Paper Day week price_discount_type: percentage price_discount_amount: 0 price_discount_percent: 10 percentage_value: '10.0' source: promo value_managed_by_droplet: false reason: null created_by: id: 20410 full_name: Michael Scott active: true automatic: false applicable_for: everything apply_only_once: false apply_to_subscriptions: false apply_to_recurring_subscription_orders: false apply_to_volume: false country_filter: apply_all customer_filter: all_customers shipping_method_filter: apply_all_methods purchase_requirement: minimum_purchase_amount purchase_requirement_applies_to_whole_cart: true has_end_date: true start_date_time: '2026-09-20T04:00:00.000Z' end_date_time: '2026-10-01T03:59:00.000Z' start_date: '2026-09-20' start_time: '00:00' end_date: '2026-09-30' end_time: '23:59' time_zone: America/New_York discount_type: product_discount total_usage: 37 free_variant_ids: [] free_enrollment_pack_ids: [] waive_enrollment_fee: false applicable_product_ids: [] inapplicable_product_ids: [] applicable_collection_ids: [] applicable_enrollment_pack_ids: [] inapplicable_enrollment_pack_ids: [] collection_ids: [] product_ids: [] customer_ids: [] country_codes: [] eligible_customer_ids: [] csv_uploaded_customer_emails: [] eligible_country_ids: [] ineligible_country_ids: [] eligible_shipping_method_ids: [] eligible_customer_segments: [] minimum_purchase_requirement_amount: 50 minimum_purchase_requirement_amount_max: null minimum_purchase_requirement_quantity: 0 minimum_cv: null maximum_cv: null customer_usage_limit: 1 minimum_amount_cents: 50 limit_usage_of_code: false limit_usage_per_customer: true other_shipping_discounts: true other_product_discounts: false created_at: '2026-09-10T19:04:22Z' updated_at: '2026-09-10T19:04:22Z' meta: request_id: 4f1c2a9e-7b3d-4e8a-9c61-2d5f8a0b3e17 timestamp: '2026-09-15T14:32:08Z' schema: allOf: - $ref: '#/components/schemas/DiscountResource' - type: object properties: meta: $ref: '#/components/schemas/Meta' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearer_auth: [] components: schemas: DiscountResource: type: object properties: id: type: integer name: type: string code: type: string price_discount_type: type: string enum: - flat - percentage - free_product - free_shipping - free_enrollment_pack price_discount_amount: type: integer price_discount_percent: type: number percentage_value: type: - string - 'null' source: type: string enum: - promo - manual - droplet value_managed_by_droplet: type: boolean reason: type: - string - 'null' created_by: type: - object - 'null' properties: id: type: integer full_name: type: - string - 'null' active: type: boolean automatic: type: boolean applicable_for: type: - string - 'null' enum: - everything - specific_products - specific_collections - except_specific_products - specific_enrollment_packs - except_specific_enrollment_packs - null apply_only_once: type: - boolean - 'null' apply_to_subscriptions: type: boolean apply_to_recurring_subscription_orders: type: boolean apply_to_volume: type: boolean country_filter: type: - string - 'null' customer_filter: type: - string - 'null' shipping_method_filter: type: - string - 'null' purchase_requirement: type: - string - 'null' purchase_requirement_applies_to_whole_cart: type: boolean has_end_date: type: - boolean - 'null' start_date_time: type: - string - 'null' format: date-time end_date_time: type: - string - 'null' format: date-time start_date: type: - string - 'null' start_time: type: - string - 'null' end_date: type: - string - 'null' end_time: type: - string - 'null' time_zone: type: - string - 'null' discount_type: type: string enum: - product_discount - shipping_discount description: type: - string - 'null' maxLength: 1000 description: Merchant-only note about the promo code. Never shown to shoppers. total_usage: type: integer free_variant_ids: type: array items: type: integer free_enrollment_pack_ids: type: array items: type: integer waive_enrollment_fee: type: boolean applicable_product_ids: type: array items: type: integer inapplicable_product_ids: type: array items: type: integer applicable_collection_ids: type: array items: type: integer applicable_enrollment_pack_ids: type: array items: type: integer inapplicable_enrollment_pack_ids: type: array items: type: integer collection_ids: type: array items: type: integer product_ids: type: array items: type: integer customer_ids: type: array items: type: integer country_codes: type: array items: type: string eligible_customer_ids: type: array items: type: integer csv_uploaded_customer_emails: type: array items: type: string eligible_country_ids: type: array items: type: integer ineligible_country_ids: type: array items: type: integer eligible_shipping_method_ids: type: array items: type: integer eligible_customer_segments: type: array items: type: string minimum_purchase_requirement_amount: type: number minimum_purchase_requirement_amount_max: type: - number - 'null' minimum_purchase_requirement_quantity: type: integer minimum_cv: type: - integer - 'null' maximum_cv: type: - integer - 'null' customer_usage_limit: type: integer minimum_amount_cents: type: integer limit_usage_of_code: type: boolean limit_usage_per_customer: type: boolean other_shipping_discounts: type: boolean other_product_discounts: type: boolean created_at: type: string format: date-time updated_at: type: string format: date-time Meta: type: object properties: request_id: type: - string - 'null' timestamp: type: string format: date-time pagination: type: object description: >- Rotulus cursor-pagination metadata (Api::MetaPagination#to_h), present on cursor-paginated responses such as GET /api/v2025-06/prices. total_count is only present when the endpoint opts into a total count. properties: cursor: type: - string - 'null' limit: type: integer prev_cursor: type: - string - 'null' next_cursor: type: - string - 'null' total_count: type: integer UnauthorizedResponse: type: object properties: message: type: string error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' ErrorResponse: type: object required: - error_message - errors - meta properties: error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' 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' ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' 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' securitySchemes: bearer_auth: type: http scheme: bearer ````