> ## 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. # Undo a specific subscription billing skip > Restore the exact owned pending skip through locked lifecycle policy. Identical already-undone retries succeed with applied false. Expired, replaced or foreign skip IDs conflict without writes. Every success includes meta.subscription_schedule with applied and authoritative current state. Canonical member credentials determine ownership; Members Site enablement and cookies are not required. Responses are no-store. Unknown fields and query parameters are rejected. ## OpenAPI ````yaml /api-reference/member-commerce-v2026-10.yaml post /api/member/v2026-10/subscriptions/{id}/undo openapi: 3.1.0 info: title: Fluid Member API v2026-10 — Commerce description: > Order and product-subscription history for the authenticated member. The bearer credential determines member and company; query filters cannot change either. Uses the same member credentials as the People API. Money is serialized as decimal strings in the enclosing currency. An order's items_count is its number of lines, not units. Individual shipments carry no status: the order's fulfillment_status is the only fulfillment state members read. A subscription's next-charge total (next_total, next_order_preview) carries the known pre-reward-points renewal charge when it can be stated from stored facts without pricing the renewal; it is null for current-rate, bundled, tax-inclusive, tax-exempt, audience-discount, expiring-discount or missing-fact subscriptions. Its subtotal is net of discounts. Authoritative saved per-line amounts are also exposed on the detail's items[]. **Sandbox test companies.** A sandbox test company is linked to a live company. While the test company cannot be reached, because sandbox access is turned off for its live company or the live company was deleted, every operation refuses a credential for it with `403` and the standard error envelope, before the operation runs. contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary version: 2026-10 servers: - url: https://api.fluid.app description: Production API server - url: https://api.fluid.test description: Local development server security: - MemberBearer: [] tags: - name: orders description: The signed-in member’s own purchases and volume-credited orders. x-fluid-section: Members - name: subscriptions description: The signed-in member’s own product subscriptions. x-fluid-section: Members - name: carts description: >- The signed-in member's own carts, addressed by checkout token, and claiming a guest cart. x-fluid-section: Commerce paths: /api/member/v2026-10/subscriptions/{id}/undo: post: tags: - subscriptions summary: Undo a specific subscription billing skip description: >- Restore the exact owned pending skip through locked lifecycle policy. Identical already-undone retries succeed with applied false. Expired, replaced or foreign skip IDs conflict without writes. Every success includes meta.subscription_schedule with applied and authoritative current state. Canonical member credentials determine ownership; Members Site enablement and cookies are not required. Responses are no-store. Unknown fields and query parameters are rejected. operationId: member_subscriptions_undo parameters: - name: id in: path required: true description: Public UUID of an owned subscription. schema: type: string format: uuid requestBody: required: true description: The exact pending skip to restore. content: application/json: schema: $ref: '#/components/schemas/SubscriptionUndo' example: skip_id: 019a23a4-9211-71bf-8fa5-a5f31a82a0e2 responses: '200': description: Fresh subscription detail after the transition. headers: Cache-Control: description: This response must not be stored. schema: type: string const: no-store content: application/json: schema: $ref: '#/components/schemas/SubscriptionEnvelope' example: status: 200 data: id: 019a23a4-9211-71bf-8fa5-a5f31a82a0de status: active frequency: interval: 1 unit: month next_billing_at: '2026-11-01T12:00:00Z' currency: USD next_total: null items_count: 1 paused_until: null created_at: '2026-10-01T12:00:00Z' items: - id: 019a23a4-9211-71bf-8fa5-a5f31a82a0e2 title: Monthly wellness bundle variant_title: Standard sku: WELLNESS-01 quantity: 1 unit_price: '20.0' total: '20.0' image_url: null shipping_address: null payment_method: null discounts: [] auto_apply_points: false next_order_preview: null meta: request_uuid: 019a23a4-9211-71bf-8fa5-a5f31a82a0de timestamp: '2026-10-01T12:00:00Z' bundle_pagination: next_cursor: null '400': description: The request body is not valid JSON. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: Missing or unusable member credential. headers: Cache-Control: description: This response must not be stored. schema: type: string const: no-store content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: The member credential is read-only. headers: Cache-Control: description: This response must not be stored. schema: type: string const: no-store content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: >- Missing or malformed subscription identifier, or a subscription outside the member and company scope. headers: Cache-Control: description: This response must not be stored. schema: type: string const: no-store content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '409': description: >- A database lock timeout, deadlock, serialization conflict, or saved-reference contention prevented the transition. Refresh and retry. Ordinary contention may wait; a changed owner returns 404. headers: Cache-Control: description: This response must not be stored. schema: type: string const: no-store content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '422': description: >- Invalid transition fields or state, unavailable reference, country change or a domain guard refused the transition. headers: Cache-Control: description: This response must not be stored. schema: type: string const: no-store content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: schemas: SubscriptionUndo: type: object description: >- Restore exactly the confirmed pending skip. An identical already-undone retry succeeds without applying another change. additionalProperties: false properties: skip_id: type: string format: uuid description: Owned pending skip UUID from current detail metadata. required: - skip_id SubscriptionEnvelope: type: object description: One accessible subscription. properties: status: type: integer description: HTTP response status. const: 200 data: $ref: '#/components/schemas/SubscriptionDetail' meta: allOf: - $ref: '#/components/schemas/ResponseMeta' - type: object properties: bundle_pagination: type: object description: Continuation for the bounded sibling candidate scan. properties: next_cursor: type: - string - 'null' description: >- Send as page[bundle_cursor] on this same detail endpoint; null when all candidates have been considered. required: - next_cursor additionalProperties: false required: - bundle_pagination required: - status - data - meta ErrorEnvelope: type: object description: Standard error envelope. properties: status: type: integer description: HTTP status code (mirrors the response status line). error: type: object properties: message: type: string description: Human-readable error message. details: type: object additionalProperties: true required: - message - details meta: $ref: '#/components/schemas/ResponseMeta' required: - status - error - meta SubscriptionDetail: type: object description: >- A subscription with its billed items, shipping, payment method, discounts and bundle. additionalProperties: false properties: auto_apply_points: type: boolean description: Whether renewal may automatically spend this member's reward points. id: type: string description: External subscription identifier. format: uuid status: type: string description: Current subscription lifecycle state. enum: - pending - active - paused - past_due - cancelled frequency: type: object description: How often the subscription bills, from its plan. additionalProperties: false properties: interval: type: - integer - 'null' description: Number of units between renewals. unit: type: - string - 'null' description: Interval unit, e.g. week or month. required: - interval - unit next_billing_at: type: - string - 'null' description: >- When the subscription next bills, or null when cancelled or paused indefinitely. format: date-time currency: type: string description: ISO 4217 currency code for this subscription's amounts. example: USD next_total: type: - string - 'null' description: >- The next order's total charge, or null when it cannot be stated without pricing the renewal. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '49.99' items_count: type: - integer - 'null' description: Units billed each cycle, or null when the saved quantity is unknown. paused_until: type: - string - 'null' description: >- When a paused subscription resumes billing, or null when not paused or paused indefinitely. format: date-time created_at: type: string description: When the subscription was created. format: date-time items: type: array description: The subscription's billed lines. items: $ref: '#/components/schemas/SubscriptionItem' shipping_address: description: The subscription's shipping destination, or null. oneOf: - $ref: '#/components/schemas/SubscriptionAddress' - type: 'null' payment_method: description: The stored payment method, or null when none is set. oneOf: - $ref: '#/components/schemas/SubscriptionPaymentMethod' - type: 'null' discounts: type: array description: Active discounts attached to the subscription. items: $ref: '#/components/schemas/SubscriptionDiscount' bundle: type: array description: >- Matching siblings from this bounded candidate page. Follow meta.bundle_pagination.next_cursor even when this array is absent; an empty candidate page can have a continuation. items: $ref: '#/components/schemas/Subscription' next_order_preview: $ref: '#/components/schemas/SubscriptionNextOrderPreview' required: - id - status - frequency - next_billing_at - currency - next_total - items_count - paused_until - created_at - items - shipping_address - payment_method - discounts - next_order_preview - auto_apply_points ResponseMeta: type: object description: Envelope metadata present on every response. properties: request_uuid: type: string format: uuid description: Server-generated UUIDv7 uniquely identifying this response. timestamp: type: string format: date-time description: ISO 8601 timestamp at which the server produced the response. subscription_schedule: $ref: '#/components/schemas/SubscriptionSchedule' required: - request_uuid - timestamp additionalProperties: true SubscriptionItem: type: object description: >- One billed line of a subscription, with its authoritative saved recurring amounts. additionalProperties: false properties: id: type: string description: >- External identifier of the subscribed variant, falling back to the subscription's own. format: uuid title: type: - string - 'null' description: Product title. variant_title: type: - string - 'null' description: Customer-facing variant title. sku: type: - string - 'null' description: Variant stock keeping unit. quantity: type: - integer - 'null' description: Units billed each cycle, or null when the saved quantity is unknown. unit_price: type: - string - 'null' description: >- Saved recurring price of one unit in major currency units, or null when unknown. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '49.99' total: type: - string - 'null' description: >- Saved recurring line total in major currency units, or null when price or quantity is unknown. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '99.98' image_url: type: - string - 'null' description: Variant image URL, falling back to the product image. required: - id - title - variant_title - sku - quantity - unit_price - total - image_url SubscriptionAddress: type: object description: >- The subscription's shipping destination, from its snapshot with an ActiveRecord fallback. additionalProperties: false properties: name: type: - string - 'null' description: Recorded name. address1: type: - string - 'null' description: Recorded address1. address2: type: - string - 'null' description: Recorded address2. city: type: - string - 'null' description: Recorded city. state: type: - string - 'null' description: Recorded state. postal_code: type: - string - 'null' description: Recorded postal code. country_code: type: - string - 'null' description: Recorded country code. required: - name - address1 - address2 - city - state - postal_code - country_code SubscriptionPaymentMethod: type: object description: >- The stored payment method's presentational fields. Never a PAN or reusable credential. additionalProperties: false properties: id: type: string description: External payment method identifier. format: uuid brand: type: - string - 'null' description: Card network or wallet brand. last4: type: - string - 'null' description: Last four digits of the stored card. required: - id - brand - last4 SubscriptionDiscount: type: object description: >- An active discount attached to the subscription, with its configured value. No computed applied amount. additionalProperties: false properties: id: type: string description: External discount attachment identifier. format: uuid code: type: - string - 'null' description: Discount code. type: type: - string - 'null' description: Price discount type, e.g. flat or percentage. flat_value: type: - number - 'null' description: Configured flat amount, when the type is flat. percentage_value: type: - number - 'null' description: Configured percentage, when the type is percentage. duration: type: - string - 'null' description: How long the discount applies, e.g. once, repeating or forever. required: - id - code - type - flat_value - percentage_value - duration Subscription: type: object description: >- Product subscription summary. next_total carries the known pre-points renewal charge, or null when the charge cannot be stated without pricing the renewal (see the detail's items[] for authoritative saved line amounts). Discarded, missing or foreign-company catalog references suppress the preview. A discarded product cannot supply the product or title required for a renewal order item. additionalProperties: false properties: id: type: string description: External subscription identifier. format: uuid status: type: string description: Current subscription lifecycle state. enum: - pending - active - paused - past_due - cancelled frequency: type: object description: How often the subscription bills, from its plan. additionalProperties: false properties: interval: type: - integer - 'null' description: Number of units between renewals. unit: type: - string - 'null' description: Interval unit, e.g. week or month. required: - interval - unit next_billing_at: type: - string - 'null' description: >- When the subscription next bills, or null when cancelled or paused indefinitely. format: date-time currency: type: string description: ISO 4217 currency code for this subscription's amounts. example: USD next_total: type: - string - 'null' description: >- The known pre-reward-points next-order total charge, or null when it cannot be stated without pricing the renewal (current-rate, bundled, tax-inclusive, tax-exempt, audience-discount, expiring-discount or missing-fact). Never a stored gross sum, which would overstate a discounted or tax-inclusive renewal. pattern: ^-?[0-9]+(?:\.[0-9]+)?$ example: '49.99' items_count: type: - integer - 'null' description: Units billed each cycle, or null when the saved quantity is unknown. paused_until: type: - string - 'null' description: >- When a paused subscription resumes billing, or null when not paused or paused indefinitely. format: date-time created_at: type: string description: When the subscription was created. format: date-time required: - id - status - frequency - next_billing_at - currency - next_total - items_count - paused_until - created_at SubscriptionNextOrderPreview: type: - object - 'null' description: >- The known pre-reward-points next-order amounts, or null when they cannot be stated without pricing the renewal. See the subscription's items[] for authoritative saved line amounts. additionalProperties: false properties: subtotal: type: string pattern: ^-?[0-9]+(?:\.[0-9]+)?$ description: Next order subtotal in major currency units, net of discounts. shipping: type: string pattern: ^-?[0-9]+(?:\.[0-9]+)?$ description: Next order shipping in major currency units. tax: type: string pattern: ^-?[0-9]+(?:\.[0-9]+)?$ description: Next order tax in major currency units. total: type: string pattern: ^-?[0-9]+(?:\.[0-9]+)?$ description: Next order total in major currency units. required: - subtotal - shipping - tax - total SubscriptionSchedule: type: object description: >- Current owned billing intent state. Present in detail-read metadata and confirmed Skip/Undo metadata; never in legacy empty-body Skip metadata. Dates use the subscription timezone. The optional applied flag appears only after a confirmed mutation and is false for an accepted replay. additionalProperties: false properties: next_bill_date: type: - string - 'null' format: date description: Current local billing date, or null when unscheduled. latest_skip_id: type: - string - 'null' format: uuid description: >- Latest historical skip UUID, including undone skips, or null before the first skip. Echo this exact epoch when confirming a new skip. pending_skip_id: type: - string - 'null' format: uuid description: Currently undoable skip UUID, or null. pending_skip_date: type: - string - 'null' format: date description: Local date skipped by the pending intent, or null. can_skip: type: boolean description: Whether current plan, state and skip allowance permit a new skip. applied: type: boolean description: >- True only when this request changed the schedule; false for an accepted replay. Omitted on reads. required: - next_bill_date - latest_skip_id - pending_skip_id - pending_skip_date - can_skip securitySchemes: MemberBearer: type: http scheme: bearer description: | A member credential in the `Authorization: Bearer` header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.