> ## 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. # Create a custom member type > Creates an active custom member type. The slug is derived from the name and remains reserved if the type is later archived. Requires admin tier and member_types.manage permission. ## OpenAPI ````yaml /api-reference/admin-v2025-06.yaml post /api/v2025-06/member-types 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/member-types: post: tags: - members summary: Create a custom member type description: >- Creates an active custom member type. The slug is derived from the name and remains reserved if the type is later archived. Requires admin tier and member_types.manage permission. operationId: admin_v2025_06_member_types_create requestBody: required: true content: application/json: example: member_type: name: Assistant to the Regional Manager permissions: rep_eligible: true pricing_tier_id: 0192a4c1-7e2b-7e9a-a3c7-81d4f5b2e069 schema: type: object required: - member_type additionalProperties: false properties: member_type: type: object required: - name additionalProperties: false properties: name: type: string minLength: 1 permissions: type: - object - 'null' additionalProperties: false properties: rep_eligible: type: - boolean - 'null' pricing_tier_id: type: - string - 'null' format: uuid description: >- A pricing tier belonging to this company. There is no current tier on create, so omitting the key and sending null are equivalent and both create the member type unlinked, which reads back as the company's Retail default. An id owned by another company is refused with 422. responses: '201': description: Member type created. content: application/json: example: member_type: id: 0199a8f0-2d6b-7a18-8e45-c3b17f9d2a06 name: Assistant to the Regional Manager slug: assistant-to-the-regional-manager system_defined: false rep_eligible: true archived_at: null pricing_tier: id: 0192a4c1-7e2b-7e9a-a3c7-81d4f5b2e069 name: Wholesale tier_level: 2 system: true archived_at: null member_type_count: 2 status: 201 meta: request_id: 6b1e8d35-0a7c-4f29-8e53-d9c2a4b7f610 timestamp: '2026-09-10T11:24:51Z' schema: $ref: '#/components/schemas/ManagedMemberTypeResponse' '401': description: Missing or invalid credentials. content: application/json: schema: $ref: '#/components/schemas/ManagedMemberTypeUnauthorizedResponse' '403': description: >- The caller is not admin tier or lacks member_types.manage permission. content: application/json: schema: $ref: '#/components/schemas/ManagedMemberTypeForbiddenResponse' '422': description: Invalid parameters or a duplicate/invalid member type. content: application/json: schema: $ref: '#/components/schemas/ManagedMemberTypeErrorResponse' security: - bearer_auth: [] components: schemas: ManagedMemberTypeResponse: type: object required: - member_type - status - meta additionalProperties: false properties: member_type: $ref: '#/components/schemas/ManagedMemberType' status: type: integer meta: $ref: '#/components/schemas/Meta' ManagedMemberTypeUnauthorizedResponse: type: object required: - message additionalProperties: false properties: message: type: string ManagedMemberTypeForbiddenResponse: oneOf: - type: object required: - message additionalProperties: false properties: message: type: string - type: object required: - error additionalProperties: false properties: error: type: string ManagedMemberTypeErrorResponse: type: object required: - error - status - meta additionalProperties: false properties: error: type: object required: - message - details additionalProperties: false properties: message: type: string details: type: object status: type: integer meta: $ref: '#/components/schemas/Meta' ManagedMemberType: type: object description: >- A company member type retained for management and historical display, including archived rows. required: - id - name - slug - system_defined - rep_eligible - archived_at - pricing_tier additionalProperties: false properties: id: type: string format: uuid name: type: string slug: type: string system_defined: type: boolean rep_eligible: type: boolean archived_at: type: - string - 'null' format: date-time description: The archival timestamp, or null while the member type is active. pricing_tier: description: >- The pricing tier this member type prices at, nested so a picker can be rendered without a second round trip. Null is meaningful and distinct from "unpriced": an unlinked member type falls back to the company's Retail tier. anyOf: - $ref: '#/components/schemas/PricingTier' - type: 'null' 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 PricingTier: type: object description: >- A company pricing tier ("Price Type" in the admin UI). Seeded system tiers (Retail, Preferred, Wholesale, ...) are always present and can be renamed but never archived; custom tiers are admin-created and DORMANT -- create is refused with 422 until the company's custom_price_types capability is enabled. Catalogs and member types both reference tiers with restrict_with_error, so archiving (never deleting) is the only removal, and forces reassignment of any member type still pointing at the tier. required: - id - name - tier_level - system - archived_at - member_type_count additionalProperties: false properties: id: type: string format: uuid name: type: string tier_level: type: integer description: >- The tier's ordinal within the company, ascending. Level 0 is the company's default (Retail) tier. Names are not unique across companies, so this is what distinguishes the seeded tiers. Custom tiers always allocate above 99. system: type: boolean description: >- True for a platform-seeded tier (tier_level < 100). System tiers can be renamed but never archived. archived_at: type: - string - 'null' format: date-time description: The archival timestamp, or null while the tier is active. member_type_count: type: integer description: >- The number of member types (including archived ones) currently pointing at this tier. Archiving with member types assigned requires reassign_to_pricing_tier_id. securitySchemes: bearer_auth: type: http scheme: bearer ````