> ## 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 <token>; 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.
> 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 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.
> 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.

# Order currency and base amounts: reporting revenue across currencies

> Every Fluid order carries its totals twice: in the currency the shopper paid in, and in US dollars in the _in_base fields. Sum amount_in_base to report revenue across currencies.

**Every Fluid order stores its totals twice.** Once in the currency the shopper paid in, and once in US dollars, Fluid's base currency, in the fields that end in `_in_base`. To report revenue across countries and currencies, add up `amount_in_base`. Every order's `amount_in_base` is in US dollars, so the sum is too.

## The two sets of amounts

| Fields | Currency | Use them for |
| - | - | - |
| `amount`, `subtotal`, `tax`, `shipping`, `discount` | The order's own currency, named by `currency_code` | Showing the order to the shopper, the rep, or the merchant, in what was charged |
| `amount_in_base`, `subtotal_in_base`, `tax_in_base`, `shipping_in_base`, `discount_in_base` | Always US dollars (`USD`) | Adding, comparing, and reporting across orders in different currencies |

The base currency is Fluid's, not the company's. A company that sells only in euros still gets its `_in_base` amounts in US dollars.

## How an order is converted

When an order is created, Fluid records the exchange rate between US dollars and the order's currency in `base_to_currency_rate`: how many units of the order's currency make one US dollar. Each base amount is the order amount divided by that rate, rounded to the cent.

For example, a German shopper pays €92.00 when the euro rate is 0.92:

```json theme={null}
{
  "currency_code": "EUR",
  "amount": "92.00",
  "base_to_currency_rate": "0.92",
  "amount_in_base": "100.00"
}
```

The rate is set once, when the order is created, and never changes. So an order's `amount_in_base` stays the same as exchange rates move, and last quarter's revenue reads the same today as it did then.

## Report revenue across currencies

* **Sum `amount_in_base`, not `amount`.** Adding `amount` across orders mixes currencies, so €92 and ¥15,000 add up to a meaningless 15,092.
* **Don't convert with today's rate.** Use the base amounts the order already has. They were converted at the rate in effect when each order was placed.
* **To show a total in another currency, convert the US dollar sum once, at the end.** Fluid's own analytics work this way. They add up the orders' `amount_in_base`, then convert.
* **Orders in the same currency can be added directly.** When every order you're adding has the same `currency_code`, their `amount` values add up correctly in that currency.

Amounts in API responses can be decimal strings. Parse them with a decimal type, not a floating-point number, before you add them.

## Edited orders

The base amounts describe the order as it was placed. An order edited after checkout keeps its original `amount_in_base`. Its new total is `current_amount`, in the order's own currency, and has no US dollar field.

To report an edited order's new total in US dollars, divide `current_amount` by the order's `base_to_currency_rate`, the same rate its base amounts used. Don't use a current exchange rate.

## Where you'll find these fields

The order responses in the API reference carry `currency_code`, `amount_in_base`, and, on most of them, `base_to_currency_rate`:

* [List the company's orders](/api-reference/orders/list-the-companys-orders) returns `currency_code` and `amount_in_base` for each order.
* [Show order](/api-reference/orders/show-order) returns the order's amounts, its base amounts, and its `base_to_currency_rate`.
* [Edit an order](/api-reference/order_edits/atomically-apply-one-or-more-edits-to-an-existing-order) returns the edited order with its `current_amount`.

Each page lists the exact fields that operation returns.

<Note>
  Some generated reference pages describe `amount_in_base` as being in "the company's base currency". It's in Fluid's base currency, US dollars, for every company.
</Note>

## Related

* [Checkout](/concepts/checkout): how an order is created.
* [API overview](/api/overview): base URLs, authentication, and pagination.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.