> ## 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. > 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. > 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 — 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. # Subscription Billing > Find failed and at-risk subscription renewals day by day, retry their payments, and email customers to update their payment method. Use **Subscription Billing** to work through a month of subscription renewals. You can spot the days with failed or at-risk renewals, open a day to see who's affected, and retry payments or email those customers from the same screen. ## Where to find it In the admin sidebar, under **Payments**, select **Subscription Billing**. To open the screen, your role needs **View only** or **Full access** for **Payment Reports**. On the [Roles](/help/admin/settings/roles) screen, **Payment Reports** is in the **Commerce** card. Open the card and set access from the **Payment Reports** area's menu. The same permission opens [Home](/help/admin/home), [Traffic](/help/admin/traffic), [Performance](/help/admin/payments/performance) and [Transactions](/help/admin/company-payment-reports). To retry payments or email customers, your role also needs **Full access** for **Subscriptions**, or **Custom** access with **Edit subscription details, pause, or cancel** turned on, in the same **Commerce** card. Without it, you can read every figure, but the selection boxes, the retry buttons and **Recommended actions** don't appear. ## What's on the screen The page header reads **Subscription Billing**, under a **Subscriptions** breadcrumb. The breadcrumb is a link only if your role can open the **Subscriptions** screen. The screen has two tabs, **Calendar** and **Analytics**, which report on the same month. It opens on **Calendar** and the current month. ### Calendar Above the month grid, a summary row shows the month's figures. Use the **Renewals** and **Recovery** switch to change what the summary and each day show, **Today** to go back to the current month, and the arrows to move between months. Only days with renewals show figures. | View | Each day shows | | :- | :- | | **Renewals** | The money collected (days that have run, including today) or scheduled (later days), and how many renewals | | **Recovery** | The money you could still recover and, on days that have run, how many renewals **need action** (failed payments that a retry can't fix, because the customer needs a new payment method). On a later day, the amount is the at-risk total. | A dot marks a day that needs a look: amber for **Elevated risk**, red for **High risk**. Point at a day for more figures, and click it to open the day panel. ### The day panel The day panel opens beside the calendar, or over it on a narrow screen. The X closes it. It has two tabs. **Overview** sums up the day: * **Collected** (a day that has run) or **Expected** (a later day), with the number of **Orders**. Click the card for a breakdown by charges, customers and products. * **Lost to failures**, when renewals failed, with how many **Failed** and how many are **Recoverable**. Click it to see **Why they failed**. On a later day, this card is **Projected loss**. * **Recommended actions**: what you can do about the day. See the tasks below. **Subscriptions** lists the day's renewals, up to 100 at a time: * **Status filters**: **All**, then whichever of **Failed**, **Retrying**, **At risk**, **Scheduled** and **Cleared** the day has. Pick one at a time. **Failed** includes renewals already queued for a retry; **Retrying** shows only those. * **Search**: the magnifying glass searches by customer or product. * **Rows**: each row shows the customer, the product and the amount. A yellow pill gives the reason a renewal is at risk, for example **Repeated declines**. A blue pill shows a booked retry, for example **Retry 14:30**. **asked to update card** means the customer was recently sent a payment update email. **Retryable** marks a failed payment that **Retry now** can charge. * **Pages**: if the day has more than 100 renewals, use the arrows at the bottom to move between pages. Click a customer to open the renewal's details: why it's at risk, the decline reason, the amount, product and market, what the customer has paid to date, past failed charges, the last attempt, any scheduled retry and the customer's **Lifetime value**. **Couldn't be billed** with **Not a card decline** means the payment failed before it reached a payment gateway. **View full subscription** opens the subscription. ### Analytics **Analytics** reports on the whole month: a summary (**Cleared first time**, **Revenue to date**, **Renewals** and **Failure rate**), **Revenue by day**, **When charges clear** by time of day and time of month, **Orders by market**, **Where failures concentrate** and **Top failure reasons**. ## Find a day's failed renewals On **Calendar**, choose **Recovery**. Each day shows the money you could still recover. Look for days with a red or amber dot. Click the day. The panel opens on **Overview**. Click **Lost to failures** to see **Why they failed**. Open **Subscriptions** and choose **Failed**. Click a customer to see the renewal's details. ## Retry failed payments **Retry now** and **Schedule** charge failed renewals again, on the payment method already on file. They only reach payments that failed in a way a retry can fix. A hard decline needs a new payment method, so it isn't retried. **Retry now** also skips renewals that already have a retry queued. In **Recommended actions**, click **Retry now** or **Schedule retries**. These cards appear when the day has payments a retry can fix. The panel switches to **Subscriptions**, with the retryable renewals on the first page selected. You can also tick rows yourself. The bar at the bottom of the list appears once you select a row. It shows how many are selected and, when some can't be retried or scheduled, how many each action can reach. If the day has more than one page, only the rows on the page you're on are included. Turning a page, changing the status filter or searching clears your selection. Click **Retry now**. The dialog shows how many payments it covers and, if they share a currency, their total. Click **Retry N payments** (for example **Retry 12 payments**) to queue them to be charged again. Click **Schedule**. Choose **In 4 hours** (the default), **In 8 hours**, **In 12 hours** or **In 20 hours**, or set **Retry at**. The time must be at least 5 minutes and at most 23 hours away, in your own time zone. Nothing is charged now. Click **Schedule N retries** to book it. The dialog shows how many renewals were queued or scheduled, and names any that weren't, with the reason. Click **Done**. If a renewal you schedule already has a retry booked, scheduling moves it to the new time instead of adding a second retry. The dialog names the existing booking first. When every selected renewal is already booked, the button reads **Move N retries**. You can't close a retry dialog while it's sending. If a retry dialog shows **Retry status unknown** or **Scheduling status unknown**, don't retry straight away. Click **Reload the day** and check the renewals first. Retrying again can charge the same card twice. ## Email customers about a payment **Recommended actions** offers two emails. Each opens a confirmation that says how many customers it will email. * **Payment failed email**: for renewals whose charge ran and failed, including those queued for a retry. It tells the customer the charge didn't go through and asks them to update their payment method. * **Payment update email**: for renewals that haven't run yet and are flagged at risk. It asks the customer to update their payment method before the renewal runs. Nothing is charged. It skips customers who were asked recently; their rows show **asked to update card**. Open the day on **Calendar**. In **Recommended actions**, click **Payment failed email** or **Payment update email**. Each card shows how many of the day's renewals it applies to. **Payment failed email** skips customers the automatic dunning emails already wrote to, and customers already sent this email in the last day. To include them, tick **Also tell customers who have already been told**. This also waives the one-day quiet period, so some customers hear about the same charge twice. It's off each time the dialog opens. Only tick this the first time you send this email for a day. Check the number on the **Email N customers** button before you send. That number is how many get the email. Then click it. The dialog shows how many emails were sent, and how many customers weren't emailed, with the reasons. Click **Done**. If a **Send status unknown** notice appears, close the dialog with **Cancel**, reload the day and check before you send again. Sending again can email the same customer twice. ## Frequently asked questions Retrying payments and emailing customers need **Full access** for **Subscriptions**, or **Custom** access with **Edit subscription details, pause, or cancel** turned on, in the **Commerce** card on the [Roles](/help/admin/settings/roles) screen. Without it, the screen is read-only. **Recommended actions** also appears only when the day has failed or at-risk renewals. None of the selected rows is a payment that **Retry now** can charge: it cleared, it hasn't run yet, it was a hard decline, or a retry is already queued. **Schedule** can still move a retry that's already booked for a set time. ## Related pages * [Subscriptions](/help/admin/subscriptions) * [Payment performance](/help/admin/payments/performance) * [Transactions](/help/admin/company-payment-reports) * [Roles](/help/admin/settings/roles) * [API overview](/api/overview) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.