> ## 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, run `fluid signup` from the Fluid CLI, or 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. # Member pricing > How price types, member types and markets decide the price a buyer sees and pays, and which company capabilities switch each part on. Member pricing lets one product carry several prices. A buyer's member type picks a price type, and the price type picks the price. This guide explains the model. It doesn't restate request and response schemas; the linked API Reference pages own those. For the storefront side, see [Member pricing in themes](https://docs.fluid.app/themes/member-storefront/member-pricing.md). ## Price types A price type is a named rank of prices that a company sets for its catalog. The API calls a price type a pricing tier, and its identifier field is `pricing_tier_id`. Every company has three system price types: | Price type | `tier_level` | | - | - | | Retail | 0 | | Preferred | 1 | | Wholesale | 2 | System price types have a `tier_level` below 100. You can rename them but never archive them. Retail is the company default. A company can also define custom price types. A custom price type gets a `tier_level` of 100 or higher and a name that no other active price type uses. Creating one returns `422` with the message "Custom price types are not enabled for this company" until the `custom_price_types` capability is on for the company. Send `copy_from_pricing_tier_id` to start the new price type from another price type's explicit prices. Archiving a price type is the only way to remove it. If member types still point at it, name another active price type in `reassign_to_pricing_tier_id` to move them first. Each price type reports how many member types use it in `member_type_count`, and `archived_at` stays `null` while it is active. [List company pricing tiers](https://docs.fluid.app/api-reference/members/list-company-pricing-tiers.md) returns the active price types in ascending `tier_level` order. Add `include_archived` to include archived ones. To change them, use [Create a custom price type](https://docs.fluid.app/api-reference/members/create-a-custom-price-type.md), [Rename a price type](https://docs.fluid.app/api-reference/members/rename-a-price-type.md) and [Archive a price type](https://docs.fluid.app/api-reference/members/archive-a-price-type.md). This example calls [List company pricing tiers](https://docs.fluid.app/api-reference/members/list-company-pricing-tiers.md) for a company that has only the system price types. **Request** ```text theme={null} Authorization: Bearer ``` **Response** ```json theme={null} { "pricing_tiers": [ { "id": "019fdbfe-1d4d-775c-8f9e-7ff1d9d9c559", "name": "Retail", "tier_level": 0, "system": true, "archived_at": null, "member_type_count": 1 }, { "id": "019fdbfe-1d59-79d0-b192-1cb76e85e3dc", "name": "Preferred", "tier_level": 1, "system": true, "archived_at": null, "member_type_count": 1 }, { "id": "019fdbfe-1d62-7e73-91a2-707f90a89b7d", "name": "Wholesale", "tier_level": 2, "system": true, "archived_at": null, "member_type_count": 1 } ] } ``` ## Member types A member type classifies the people who buy from a company. Each member type points at one price type, and that link is what connects a buyer to a price. Every company has three system member types: | Member type | Slug | Price type | `rep_eligible` | | - | - | - | - | | Customer | `customer` | Retail | `false` | | Preferred | `preferred` | Preferred | `false` | | Rep | `rep` | Wholesale | `true` | A member type with no price type reads back as `pricing_tier: null` and prices at Retail, except on a company moved to strict pricing, where it has no price; see [Strict price types](#strict-price-types). A custom member type you create starts that way, unless you send a `pricing_tier_id`. You can assign a custom price type once `catalog_writes` is on for the company; until then only system price types. An archived price type is refused. When `catalog_writes` is on for the company, a cart charges the price type of the buyer's member type. An enrollment cart charges the price type of the member type the buyer enrolls into. A rep who holds a Preferred member type pays Preferred, because being a rep doesn't override the member type. [List company member types](https://docs.fluid.app/api-reference/members/list-company-member-types.md) returns every member type, archived ones included, with its price type nested under `pricing_tier`. Use [Create a custom member type](https://docs.fluid.app/api-reference/members/create-a-custom-member-type.md) and [Update a member type](https://docs.fluid.app/api-reference/members/update-a-member-type.md) to change them. This example calls [List company member types](https://docs.fluid.app/api-reference/members/list-company-member-types.md) for a company that has only the system member types. **Request** ```text theme={null} Authorization: Bearer ``` **Response** ```json theme={null} { "member_types": [ { "id": "019de9c6-2c95-7908-9422-6e4f3bb33b1c", "name": "Customer", "slug": "customer", "system_defined": true, "rep_eligible": false, "archived_at": null, "pricing_tier": { "id": "019fdbfe-1d4d-775c-8f9e-7ff1d9d9c559", "name": "Retail", "tier_level": 0, "system": true, "archived_at": null, "member_type_count": 1 } }, { "id": "019fdbfe-1da6-7cea-a735-bc34075587b3", "name": "Preferred", "slug": "preferred", "system_defined": true, "rep_eligible": false, "archived_at": null, "pricing_tier": { "id": "019fdbfe-1d59-79d0-b192-1cb76e85e3dc", "name": "Preferred", "tier_level": 1, "system": true, "archived_at": null, "member_type_count": 1 } }, { "id": "019de9c6-2c7a-78f1-b195-01426f5734bc", "name": "Rep", "slug": "rep", "system_defined": true, "rep_eligible": true, "archived_at": null, "pricing_tier": { "id": "019fdbfe-1d62-7e73-91a2-707f90a89b7d", "name": "Wholesale", "tier_level": 2, "system": true, "archived_at": null, "member_type_count": 1 } } ] } ``` ## How a price resolves Fluid prices a variant for one buyer in one country. The buyer's member type gives the price type. The country gives the market. These steps run in order, and the first one that yields a price wins: 1. **Market.** Fluid maps the country to its region and uses the market for that region. If the country or its region has no market, Fluid uses the company's first market by position, except on a company moved to strict pricing, where the variant has no price. A company with no markets has no price. 2. **Catalog.** Fluid uses the market's catalog for the price type. If the price type has no catalog in that market, Fluid uses the market's base catalog, which holds the Retail prices. A strict price type skips this fallback; see [Strict price types](#strict-price-types). 3. **Price.** Fluid uses the explicit price stored for the variant in that catalog's price list. If there is none and the price list has a blanket adjustment, Fluid applies the adjustment to the base catalog's price. If there is neither, the variant has no price. For a company moved to strict pricing, steps 2 and 3 have no fallback for any price type. For a member, a price is the member type, then that member type's price type, then that price type's own explicit price. A guest starts at the company's Retail price type. There is no base catalog, no blanket adjustment, no per-variant price column and no other price type to fall back on. If any link is missing, the variant has no price and can't be sold. [List a product's explicit catalog prices](https://docs.fluid.app/api-reference/products/list-a-products-explicit-catalog-prices.md) and [List explicit catalog prices for several products](https://docs.fluid.app/api-reference/products/list-explicit-catalog-prices-for-several-products-paginated-by-variant.md) return the stored rows. [Write a batch of price-grid cells](https://docs.fluid.app/api-reference/products/write-a-batch-of-price-grid-cells.md) changes them. Prices are stored per variant, market and currency, not per country. Two countries in the same region share a market, so they share prices. Rows are sparse: a variant with no explicit price for a price type usually has no row, which isn't the same as a price of zero. The exception is a company moved to strict pricing: where the subscription price list exists, a variant with neither price can come back as a row with `one_time` null and `subscription` set to `{"unset": true}`. A row's presence doesn't mean a price is configured. ### Strict price types Once `catalog_writes` is on for a company, Preferred and every custom price type are strict. A strict price type has no fallback. It needs its own catalog and an explicit price for the variant, and a blanket adjustment doesn't count. Retail and Wholesale keep the fallbacks above until Fluid moves a company to strict pricing. Then they are strict too: each prices from its own explicit catalog prices or not at all, with no base catalog fallback and no per-variant retail or wholesale price column. Guests are priced from the company's own Retail price type. Members, reps included, are priced from their member type's own price type, so a rep with a Preferred member type pays Preferred. A member type with no price type, or a member with no member type, has no price there, and a member type must be given its own active price type. A cart whose destination country is in none of the company's markets is refused at checkout. The `member_pricing` capability object doesn't report this. The catalog price endpoints do: their `CatalogPricesResponse` carries a top-level `no_fallback` boolean that tells you whether the company is on the no-fallback gate. ### Products, variants and bundles A price belongs to a variant. A product with several variants has a price for each one. A bundle has no variant to price. Where its prices live depends on the `bundle_pricing` capability, which is described below. * **`bundle_pricing` off.** The bundle price grid isn't available. This doesn't tell you where the bundle's price is read from: a company with bundle catalog reads on but catalog writes off reports `false` and can still price a bundle from stored catalog prices. Otherwise the bundle's prices are per-country settings on the bundle. With bundle-level pricing on, the bundle has one fixed price per country. With it off, the bundle's price is built from the prices of its groups. * **`bundle_pricing` on.** The bundle's prices are stored per price type, market and currency, like other catalog prices. This covers the bundle's own price, its groups and the items in them. Bundle-level pricing is still a choice you make per bundle. [Show a bundle's per-price-type price grid](https://docs.fluid.app/api-reference/products/show-a-bundles-per-price-type-price-grid.md) reports which applies in `pricing_enabled`, and [Write a batch of bundle price cells](https://docs.fluid.app/api-reference/products/write-a-batch-of-bundle-price-cells.md) changes the cells. ### What unavailable means A price is unavailable when no price exists for the buyer's price type in that country. On the catalog path, once the fallbacks above are used up, Fluid doesn't invent a substitute and never reads a missing price as zero. A strict price type gets no fallbacks at all, and on a company moved to strict pricing that includes Retail and Wholesale. Without catalog reads, an unset wholesale price reads as 0.00; see [When a capability is off](#when-a-capability-is-off). * With `bundle_pricing` off, a bundle is unavailable in a country when its fixed price has no enabled entry with a price for that country, or when any group with country pricing has no enabled entry for it. * A cart line for a bundle that can't be priced for the buyer's price type sets `price_unavailable` to `true`, returns null price fields, and checkout refuses it. * A cart line that a strict price type can't price is refused before payment is held. Apple Pay, Google Pay, Bread, Affirm, Braintree pay and PayPal answer `422` with `meta.code` set to `strict_tier_line_refused`. Checkout `complete` refuses the cart with `422` and describes the reason in `meta.error_details`. Don't depend on a specific detail code there. * On a company moved to strict pricing, a cart whose destination country is in none of the company's markets is refused at checkout. Apple Pay, Google Pay, Bread, Affirm, Braintree pay and PayPal answer `422` with `meta.code` set to `destination_market_unavailable`. Checkout `complete` refuses the cart with `422` and `checkout_unavailable` in `meta.error_details`. * On a company moved to strict pricing, a member type with no price type of its own, and a member with no member type, are refused. Apple Pay, Google Pay, Bread, Affirm, Braintree pay and PayPal answer `422` with `meta.code` set to `strict_tier_line_refused`. Checkout `complete` refuses the cart with `422` and describes the reason in `meta.error_details`. Don't depend on a specific detail code there. * On a company moved to strict pricing, saving a batch of price-grid cells with a blank or 0 subscription price is rejected with `422`. The response lists the cell, with `price` in its `fields` and a message. Other price writes may remove the subscription row instead. * A cart change that re-prices the cart, when the cart still holds a line on a deactivated plan, is refused, usually with `422`. A metadata-only update isn't. The response can carry `subscription_plan_inactive` in `meta.code`, but don't depend on the code or the status for any particular write, and another pricing refusal can come first. A new subscription created on a deactivated plan answers `422` with `subscription_plan_inactive` in `meta.code`. Deleting the line, or unsubscribing it with the [Unsubscribe a cart item](https://docs.fluid.app/api-reference/cart-items/unsubscribe-a-cart-item.md) operation (`DELETE /api/checkout/v2026-04/carts/{cart_token}/items/{item_id}/subscription`), is the way out. A general item update that switches one line to one-time is refused while another inactive-plan line remains. See [Recurring prices](#recurring-prices). * On a company moved to strict pricing with `bundle_pricing` on, a bundle with no stored Retail or Wholesale price, or whose price type has no record, is refused. It is never priced at zero. ### Recurring prices A recurring price can differ from the one-time price. It is stored apart from the one-time price, per price type, so a price row has a `subscription` field next to `one_time`. * If the price type has a subscription price list but it holds no row for the variant, the recurring price follows the one-time price, as long as the variant has a one-time price. The price row reports this as `follows_one_time`. This applies only to a company that isn't moved to strict pricing. * On a company moved to strict pricing, a missing subscription row is never followed to the one-time price. The price row reports `{"unset": true}`, and a plan that reads stored subscription amounts can't sell the variant on subscription for that price type until a subscription price is written. An active percentage plan is unaffected, because its price comes from the one-time price. Saving a batch of price-grid cells with a blank or 0 subscription price is rejected with `422`. * If the price type has no subscription price list, there is no recurring price. It doesn't follow the one-time price. * If the subscription plan's `price_adjustment_type` is `percentage`, the recurring price is the one-time price less that percentage. It doesn't read a stored amount. * For a renewal of an existing subscription on an inactive plan, when the company isn't moved to strict pricing, the plan grants no discount, so the recurring price is the one-time price. * For a renewal on a company moved to strict pricing, an inactive plan is not priced from the one-time price. It reads the amount stored in its own plan price list for that price type, and a plan with no such list has no recurring price. * A cart that holds a line whose plan was deactivated after it was added, or a new subscription on an inactive plan, is refused rather than priced as another plan. This applies to every company. Renewals of existing subscriptions are not carts, so the inactive-plan pricing above still applies to them. The shopper deletes the line or unsubscribes it with the [Unsubscribe a cart item](https://docs.fluid.app/api-reference/cart-items/unsubscribe-a-cart-item.md) operation. * A blanket adjustment never prices a recurring price. A bundle keeps its recurring price per price type and currency, and can override it per subscription plan in `plan_overrides`. ## The capabilities that gate it Fluid turns member pricing on one company at a time. It isn't a setting you change in the company yourself. Fluid works out the answer from its rollout configuration each time it is asked, and reports it in a `member_pricing` object on the company record that Fluid Admin loads. | Capability | Meaning when `true` | | - | - | | `catalog_reads` | Prices resolve through markets and catalogs. | | `catalog_writes` | Price edits write the catalog directly, and the catalog price endpoints are available. | | `custom_price_types` | The company can create custom price types. It currently mirrors `catalog_writes`. | | `preferred_editable` | Preferred is the company's own price, not a copy of Retail. It currently mirrors `catalog_writes`. | | `bundle_pricing` | Bundle prices are stored per price type, and the bundle price grid is available. | Charging a member type's price type isn't a separate field. It is on exactly when `catalog_writes` is on. This example shows a company that reads from catalogs and writes to them, so it can create custom price types and edit Preferred, but where the bundle price grid is off. ```json theme={null} { "member_pricing": { "catalog_reads": true, "catalog_writes": true, "custom_price_types": true, "preferred_editable": true, "bundle_pricing": false } } ``` ### When a capability is off * **`catalog_reads` off.** Prices come from each variant's per-country retail and wholesale price columns. These can't express a Preferred or custom price type. Both columns default to 0.00, so a wholesale price that was never set reads as 0.00, not as missing. * **`catalog_writes` off.** The catalog price reads answer `422`, the catalog price writes are refused, and creating a custom price type answers `422`. * **`preferred_editable` off.** The Preferred price type holds the same prices as Retail, and Preferred members can't be charged a separate price. * **`bundle_pricing` off.** The bundle price grid answers `422`, and a bundle is priced from its fixed price or its groups. * **Charges off.** A member type's price type doesn't affect what a cart charges. A cart linked to a wholesale rep, and any enrollment cart, charges Wholesale. Every other cart charges Retail. Member-facing product pages show Wholesale to members whose member type is `rep_eligible` and Retail to everyone else, so the page matches the cart. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.