> ## 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. # Update a subscription (PATCH) > Update a subscription. The same update as `PUT /api/subscriptions/{token}`: both methods reach one action, accept the same body, change only the keys the request sends and return the same responses. Read that operation for the `status` cancellation and reactivation rules. ## OpenAPI ````yaml /api-reference/company-v0.yaml patch /api/subscriptions/{token} openapi: 3.1.0 info: title: Fluid Company API description: | **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 in this API that resolves the company from the request's credential refuses a credential for it with `403` and the body `{"error": ""}`, before the operation runs. The refusal is documented here once rather than on each operation. version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] paths: /api/subscriptions/{token}: patch: tags: - subscriptions summary: Update a subscription (PATCH) description: >- Update a subscription. The same update as `PUT /api/subscriptions/{token}`: both methods reach one action, accept the same body, change only the keys the request sends and return the same responses. Read that operation for the `status` cancellation and reactivation rules. operationId: commerce_v0_update_subscription_patch parameters: - name: token in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/UpdateSubscription' responses: '200': $ref: '#/components/responses/UpdateSubscriptionOk' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/StandardUnauthorizedResponse' '404': $ref: '#/components/responses/UpdateSubscriptionNotFound' '409': $ref: '#/components/responses/UpdateSubscriptionConflict' '422': $ref: '#/components/responses/UpdateSubscriptionUnprocessable' security: - bearer_auth: [] components: requestBodies: UpdateSubscription: required: true content: application/json: schema: $ref: >- #/components/schemas/UpdateSubscriptionRequestBodyApplicationJsonSchema description: Request payload example: subscription: quantity: 2 address_id: 73518 payment_method_id: 90412 description: >- Subscription params. next_bill_date (YYYY-MM-DD) calculated internally if not provided. Do not pass timezone in metadata as it will be ignored. responses: UpdateSubscriptionOk: description: | Success. A `bundle`-scoped `auto_apply_points` write also carries `resolved_subscription_tokens` and `changed_subscription_tokens` alongside the subscription: every token the write covered, and the subset it actually changed. content: application/json: schema: $ref: '#/components/schemas/JsonValue' example: subscription: id: 184305 address: id: 73518 address1: 18 Main Street address2: null address3: null city: Nashua country_code: US country_num_code: 840 default: true name: Holly Flax phone: '+16035550147' postal_code: '03060' state: NH subdivision_code: null address_id: 73518 attempts: 0 auto_apply_points: false baked_discounts: [] base_recurring_price: 54.99 billing_cycle_limit_reached: false bundled_items: [] bundled_subscriptions: [] cancelled_at: null company: id: 1405 name: Dunder Mifflin Paper Company country: id: 214 iso: US name: United States created_at: '2026-09-02T15:24:51Z' currency: id: 1 active: true code: USD name: United States Dollar rate: '1.0' symbol: $ customer: id: 48213 account_id: DM-48213 active: true addresses: - id: 73518 address1: 18 Main Street address2: null address3: null city: Nashua country_code: US country_num_code: 840 default: true name: Holly Flax phone: '+16035550147' postal_code: '03060' state: NH subdivision_code: null created_at: '2026-09-02T15:18:44Z' customer_notes: [] default_address: id: 73518 address1: 18 Main Street address2: null address3: null city: Nashua country_code: US country_num_code: 840 default: true name: Holly Flax phone: '+16035550147' postal_code: '03060' state: NH subdivision_code: null display_total_spent: $164.97 (USD) email: holly.flax@gmail.com email_marketing: true external_id: null first_name: Holly full_name: Holly Flax is_discarded: false is_rep: false last_name: Flax last_order_id: null metadata: {} name: Holly Flax notes: null orders_count: 3 payment_methods: - id: 90412 company_id: 1405 created_at: '2026-09-02T15:21:08Z' logo_url: https://assets.fluid.app/images/payment_icons/visa.svg payment_title: Credit Card source: card updated_at: '2026-09-02T15:21:08Z' user_id: null phone: '+16035550147' role: customer sales_tax_id: null sms_marketing: false tax_exempt: false total_spent: '164.97' user_company_id: 48213 verified_email: true customer_notes: - id: 5582 created_at: '2026-09-12T14:03:27Z' customer_id: 48213 note: >- Customer asked to move deliveries to the first half of the month. resource_id: 184305 resource_type: Commerce::Subscription user_company: id: 20417 first_name: Dwight last_name: Schrute full_name: Dwight Schrute email: dwight.schrute@dundermifflin.com image_url: >- https://cdn.fluid.app/dunder-mifflin/avatars/dwight-schrute.jpg user_company_id: 20417 cv: '40.0' cv_total: '80.0' decline_count: 0 digital: false disabled: false last_bill_date: '2026-09-02T15:24:51Z' last_failed_at: null last_ship_date: null max_skips: null next_bill_date: '2026-10-02T14:00:00Z' next_retry_at: null next_ship_date: '2026-10-03T14:00:00Z' notes: null orders: [] original_price: 54.99 payment_method: id: 90412 au_status: null billing_address: null created_at: '2026-09-02T15:21:08Z' default: true details: id: 90412 type: CreditCard card_network: visa card_brand: Visa last4_digits: '4242' last_four: '4242' exp_month: '11' exp_year: '2029' logo_url: https://assets.fluid.app/images/payment_icons/visa.svg vgs_card_id: null requires_3ds: false payment_title: Credit Card payment_type: Credit Card source: card updated_at: '2026-09-02T15:21:08Z' price: 49.99 quantity: 2 qv: '40.0' qv_total: '80.0' renewal_discount_total: 0 skipped_count: 0 status: active subscription_discounts: [] subscription_plan: id: 3127 active: true allow_max_billing_cycles: false allow_skipping: true apply_to_volume: true billing_frequency_in_words: 1 month billing_interval: 1 billing_interval_unit: month company_default: true created_at: '2026-09-01T13:00:00Z' max_billing_cycles: null max_skips: 2 name: Monthly Paper Delivery price_adjustment_amount: 5 price_adjustment_type: fixed_amount products_count: 4 savings_display_mode: amount shipping_interval: 1 shipping_interval_unit: month split_volume: false subscribers_count: 212 trial_period: null trial_period_unit: null updated_at: '2026-09-01T13:00:00Z' volume_interval: 1 volume_interval_unit: month subscription_skips: [] subscription_token: sb_3f9a1c7e5b2d4086 successful_billing_cycles: 1 timezone: America/New_York updated_at: '2026-09-30T13:20:44Z' variant: id: 61842 currency_code: USD display_name: null image_path: null image_url: null options: [] price: '54.99' price_in_currency: $54.99 primary_image: null product: id: 20931 canonical_url: https://shop.dundermifflin.com/products/20lb-copy-paper cv: '40.0' cv_in_currency: $40.00 external_id: null image_path: null image_url: >- https://cdn.fluid.app/dunder-mifflin/products/20lb-copy-paper.jpg introduction: null metadata: {} metafields: [] price: '54.99' price_in_currency: $54.99 sku: DM-20LB tax: '0.0' tax_in_currency: $0.00 title: Dunder Mifflin 20lb Copy Paper sku: DM-20LB-CASE title: null volume_rep: id: 20417 email: dwight.schrute@dundermifflin.com full_name: Dwight Schrute image_url: >- https://cdn.fluid.app/dunder-mifflin/avatars/dwight-schrute.jpg external_id: DM-REP-0007 volume_rep_member_id: 3b8e2f41-9c6d-4a7e-b215-6f0d8c3a9e74 resolved_subscription_tokens: - sb_3f9a1c7e5b2d4086 changed_subscription_tokens: - sb_3f9a1c7e5b2d4086 meta: request_id: 1f7c3a95-8e2d-4b60-9a14-5c3e7d2b8f61 timestamp: '2026-09-30T13:20:44Z' UpdateSubscriptionNotFound: description: >- Subscription not found, or not visible to the authenticated caller (for example a rep token for a subscription credited to another rep). content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' UpdateSubscriptionConflict: description: | A `bundle`-scoped `auto_apply_points` write could not read a stable renewal bundle. Another writer changed the bundle twice while this request was being applied, so the single retry was spent and nothing was written. `meta.code` is `bundle_membership_conflict`. Refetch the subscription and submit again. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' UpdateSubscriptionUnprocessable: description: >- Validation failure (including `subscription.metadata` containing platform-reserved keys, which the error names) or subscription activation blocked by the current plan billing-cycle limit. `meta.code` is `tax_quote_unavailable` when the subscription is cancelled, the request sends a `status` other than `cancelled`, the selling country or the ship-to country uses a tax mode that cannot calculate tax at renewal (Sovos), and the customer is not tax exempt. The ship-to country is the country of the `address_id` the request sends, or of the subscription's own address when it sends none. Nothing is written and the subscription stays cancelled. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' examples: tax_quote_unavailable: summary: Tax cannot be calculated at renewal value: error_message: >- We can't calculate tax for this order right now. Please try again in a few minutes. errors: subscription: - >- We can't calculate tax for this order right now. Please try again in a few minutes. meta: request_id: 2e8c5a19-6f3d-4b70-9d41-a7c3e1b5f862 timestamp: '2026-10-30T12:00:00Z' code: tax_quote_unavailable schemas: StandardUnauthorizedResponse: description: Common legacy unauthorized response envelope. allOf: - $ref: '#/components/schemas/StandardErrorResponse' UpdateSubscriptionRequestBodyApplicationJsonSchema: type: - object - 'null' properties: token: type: - string - number - integer - 'null' id: type: - integer - string - number - 'null' subscription: type: - object - 'null' properties: subscription_plan_id: type: - integer - string - number - 'null' customer_id: type: - integer - string - number - 'null' variant_id: type: - integer - string - number - 'null' address_id: type: - integer - string - number - 'null' payment_method_id: type: - integer - string - number - 'null' order_item_id: type: - integer - string - number - 'null' status: type: - string - number - integer - 'null' disabled: type: - boolean - 'null' quantity: type: - integer - string - number - 'null' metadata: description: >- Free-form metadata. Keys the platform owns are reserved and refused with a `422` that names them, on both create and update: `cv`, `qv`, `base_cv`, `base_qv`, `volume_basis`, `volume_store`, `dunning_retry`, `dunning_notice`, `retry_refusal`, `auto_apply_points`, `discounts`, `total_discount_amount`, `cart_token`, `bundled_items`, `is_bundle`, `capture_source`, `recurring_rule`. This applies to every company, including those on legacy pricing. `timezone` changes are not supported through this field. type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' notes: type: - string - number - integer - 'null' next_bill_date: type: - string - number - integer - 'null' format: date-time volume_rep_id: type: - integer - string - number - 'null' auto_apply_points: description: | Whether renewals redeem the customer's reward points before the card charge. Only the two real booleans are accepted; truthy shapes like `1` or `"true"` are rejected rather than coerced. type: - boolean - 'null' auto_apply_points_scope: description: | How far the `auto_apply_points` write reaches. `subscription`, the default when omitted, writes this record alone. `bundle` writes every subscription that renews with it, atomically, because the points are spent against one renewal order. Under `bundle` this endpoint accepts only what a bundle write can apply: `auto_apply_points` (required), plus `payment_method_id` and `quantity`, which land on the addressed subscription alone. Every other property here is refused with a `422` naming the offending key rather than being dropped. A `bundle` write can also return `409` when the renewal bundle could not be read stably, and its success body carries `resolved_subscription_tokens` and `changed_subscription_tokens` alongside the subscription. type: - string - 'null' enum: - subscription - bundle - null JsonValue: description: >- Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract. anyOf: - type: string - type: number - type: boolean - type: 'null' - type: array items: $ref: '#/components/schemas/JsonValue' - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' StandardErrorResponse: description: >- Common legacy error response envelope. Older endpoints may return one or more of these fields depending on the controller path. type: object properties: message: type: string error: $ref: '#/components/schemas/ErrorMessage' error_message: $ref: '#/components/schemas/ErrorMessage' errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' additionalProperties: $ref: '#/components/schemas/JsonValue' ErrorMessage: description: An API error message represented as text or structured JSON. anyOf: - type: string - $ref: '#/components/schemas/ErrorBag' - type: 'null' ErrorBag: description: >- Validation errors keyed by field, a list of errors, a single error message, or null when no structured error details are available. anyOf: - type: string - type: array items: $ref: '#/components/schemas/ErrorValue' - type: object additionalProperties: $ref: '#/components/schemas/ErrorValue' - type: 'null' Meta: type: - object - 'null' properties: request_id: type: - string - number - integer - 'null' timestamp: type: - string - number - integer - 'null' format: date-time code: type: string description: >- Machine code for the refusal, for example `payment_unconfirmed`, or `next_bill_date_blackout` when a merchant caller picks a bill date on a blackout day. A customer JWT is never refused for a blackout day; its date is saved on the next open day. blocked_date: type: string format: date description: >- Present with `next_bill_date_blackout`. The date that was refused, as an ISO 8601 calendar date. example: '2026-11-30' blocked_day: type: integer minimum: 1 maximum: 31 description: >- Present with `next_bill_date_blackout`. The day of the month of `blocked_date`. example: 30 allowed_date: type: string format: date description: >- Present with `next_bill_date_blackout`. The nearest date the merchant's blackout rules allow, the date to offer instead. example: '2026-11-28' payment_uuid: type: string description: >- Present with `payment_unconfirmed`. The payment to look up before charging again. error_details: type: array minItems: 1 description: >- Every reason this checkout was refused, each with a stable `code`, the cart `field` to fix, and the `payment` outcome. items: $ref: '#/components/schemas/CheckoutErrorDetail' coded_recovery: type: boolean description: >- Present and true when the company routes checkout refusals by `error_details` (CHECKOUT_CODED_REFUSALS). Temporary; removed with that flag. ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' CheckoutErrorDetail: description: >- One refusal reason, in the same vocabulary as `checkout_blockers`, with where to send the shopper and what happened to the payment. type: object additionalProperties: false required: - code - field - payment - message properties: code: type: string description: Stable refusal code. Codes reuse the `checkout_blockers` codes. field: type: - string - 'null' description: >- The cart API path to send the shopper to, for example `shipping_address.postal_code` or `items[123]`, or null. payment: type: string enum: - not_attempted - declined - unknown - held description: >- `not_attempted`: fix the cause and resubmit. `declined`: the payment was refused; resubmit with another method. `declined` reflects the stored payment status; for some gateways an unconfirmed failure is still reported as `declined`. `unknown`: money may have moved; check the order before charging again. `held`: the cart's only money is the payment a resubmit reuses. Fix the field and resubmit with the same payment method; checkout will not charge again. message: type: string description: The English message for this entry. Not translated. securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.