> ## 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 orders (PUT) > The PUT form of `PATCH /api/company/orders/{id}`. Both methods reach one update action, take the same body and return the same responses. Read that operation for the details. ## OpenAPI ````yaml /api-reference/company-v0.yaml put /api/company/orders/{id} 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/company/orders/{id}: put: tags: - company summary: Update orders (PUT) description: |- The PUT form of `PATCH /api/company/orders/{id}`. Both methods reach one update action, take the same body and return the same responses. Read that operation for the details. operationId: company_v0_company_orders_put parameters: - name: id in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/UpdateCompanyOrder' responses: '200': $ref: '#/components/responses/UpdateCompanyOrderOk' '400': $ref: '#/components/responses/UpdateCompanyOrderBadRequest' '401': $ref: '#/components/responses/UpdateCompanyOrderUnauthorized' '403': $ref: '#/components/responses/UpdateCompanyOrderForbidden' '404': $ref: '#/components/responses/UpdateCompanyOrderNotFound' security: - bearer_auth: [] components: requestBodies: UpdateCompanyOrder: required: true content: application/json: schema: type: object required: - order properties: order: type: object properties: status: type: string description: New order status. external_id: type: string description: Identifier from your external system. name: type: string email: type: string phone: type: string shipped_on: type: string description: When the order shipped. delivered_on: type: string description: When the order was delivered. user_id: type: integer contact_id: type: integer share_id: type: integer tracking_informations_attributes: type: array description: Tracking numbers to add, or to change when `id` is given. items: type: object properties: id: type: integer tracking_number: type: string shipping_carrier: type: string description: >- The attributes to change. Send at least one of them. A body without the `order` key is also accepted through Rails' JSON parameter wrapping, but the wrapped form is the contract. example: order: status: shipped shipped_on: '2026-09-15' tracking_informations_attributes: - tracking_number: 1Z999AA10123456784 shipping_carrier: UPS responses: UpdateCompanyOrderOk: description: Success content: application/json: schema: $ref: '#/components/schemas/CompanyOrderDetailResponse' example: id: 48213 order_number: DM-10482 external_id: NS-SO-77120 status: shipped currency_code: USD first_name: Holly last_name: Flax email: holly.flax@dundermifflin.com amount: '123.57' subtotal: '109.98' discount: '0.0' transaction_fee: '0.0' enrollment_fee: '0.0' total_display_amount: $123.57 sub_total_in_currency: $109.98 tax_in_currency: $6.60 discount_in_currency: $0.00 total_cv: '80.0' total_qv: '80.0' order_on_behalf_of: false item_refunds_allowed: true company_country_tax_inclusive_pricing: null warehouse_name: Scranton Warehouse created_at: '2026-09-14T15:32:08Z' updated_at: '2026-09-15T13:05:44Z' items: - id: 90417 title: Dunder Mifflin 20lb Copy Paper quantity: 2 price: '54.99' paid_amount: 109.98 refundable_quantity: 2 cv_total: '80.0' qv_total: '80.0' source_subscription: null price_inclusive_of_tax: false price_inclusive_tax_name: null totals: gross_subtotal: '109.98' gross_subtotal_in_currency: $109.98 net_subtotal: '109.98' net_subtotal_in_currency: $109.98 item_tax: '6.6' item_tax_in_currency: $6.60 shipping_net: '6.99' shipping_net_in_currency: $6.99 shipping_tax: '0.0' shipping_tax_in_currency: $0.00 total_tax: '6.6' total_tax_in_currency: $6.60 price_inclusive_of_tax: false tax_label: Sales Tax UpdateCompanyOrderBadRequest: description: >- The update failed. When `order` carries no attribute the endpoint accepts (for example `{"order": {}}`), the body is the API's failure envelope (`{"status": "fail", "data": {"error": …}}`); when the order fails validation it is the validation errors keyed by field. content: application/json: schema: anyOf: - $ref: '#/components/schemas/FailureEnvelopeResponse' - $ref: '#/components/schemas/ValidationErrorsResponse' UpdateCompanyOrderUnauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' UpdateCompanyOrderForbidden: description: >- The token is not a company admin's (`{"message": …}`); or its role lacks orders.update, a droplet token lacks the orders scope, or a public token is used (`{"error": …}`). content: application/json: schema: $ref: '#/components/schemas/StandardForbiddenResponse' UpdateCompanyOrderNotFound: description: >- The company has no order with this ID. The body is `{"error": …}` with the localized message (`Order not found.` in English). The order is looked up before the orders.update check, so a token without that permission gets this 404, not the 403, for an ID the company does not have. content: application/json: schema: $ref: '#/components/schemas/StandardErrorResponse' schemas: CompanyOrderDetailResponse: type: object additionalProperties: false description: >- A single order as returned by the company order detail, update and find-by-external-id operations. properties: id: type: integer first_name: type: - string - 'null' last_name: type: - string - 'null' email: type: - string - 'null' order_number: type: - string - 'null' description: >- The order's human-readable number. Null only on legacy orders stored without one. source: type: string amount: type: string description: Decimal string. amount_in_base: type: string description: Decimal string. base_to_currency_rate: type: - string - 'null' note: type: - string - 'null' currency_code: type: - string - 'null' description: >- The order's ISO currency code. Null only on legacy orders stored without one. created_at: type: string format: date-time updated_at: type: string format: date-time metadata: type: object token: type: string order_status: type: string fulfillment_status: type: string financial_status: type: string warehouse_id: type: - integer - 'null' points_applied: type: integer points_applied_decimal: type: string pattern: ^-?\d+\.\d{4}$ example: '120.0000' description: Points applied to this order as a four-decimal string points_applied_amount: type: number points_applied_amount_in_currency: type: string order_total_after_points_redemption: type: number total_points_credited: type: integer total_points_credited_decimal: type: string pattern: ^-?\d+\.\d{4}$ example: '120.0000' description: Points credited from this order as a four-decimal string free_shipping: type: boolean discount_codes: type: array items: type: string created_subscriptions: type: array items: type: string currency_symbol: type: string items_count: type: integer quantity_count: type: integer external_id: type: - string - 'null' shipping_in_base: type: string tax_in_base: type: string description: Decimal string. subtotal_in_base: type: string description: Decimal string. enrollment_fee_in_base: type: string description: Decimal string. discount_in_base: type: string description: Decimal string. sale_date: type: - string - 'null' format: date-time order_on_behalf_of: type: boolean total_display_amount: type: string total_cv: type: string format: decimal total_qv: type: string format: decimal customer: type: object shipping_address: type: - object - 'null' billing_address: type: - object - 'null' items: type: array items: type: object ship_to: type: - object - 'null' bill_to: type: - object - 'null' subscriptions: type: array items: type: object subscription: type: - object - 'null' current_adjustment_total: type: string description: Decimal string. current_subtotal: type: string current_discount: type: string current_tax: type: string current_shipping: type: string current_amount: type: string current_cv: type: - string - 'null' format: decimal current_qv: type: - string - 'null' format: decimal adjustments: type: array items: type: object price_inclusive_of_tax: type: - boolean - 'null' deprecated: true description: >- Whether the prices are inclusive of tax (deprecated, use totals.price_inclusive_of_tax — this field is not gated on the tax strategy and can disagree with the served totals) price_inclusive_tax_name: type: - string - 'null' deprecated: true description: >- The tax name shown beside an inclusive price (deprecated, use totals.tax_label) totals: $ref: '#/components/schemas/TaxTotalsBreakdown' company_country_tax_inclusive_pricing: type: - boolean - 'null' description: >- Raw tax_inclusive_pricing override on the company's country record for this order's country, or null when there is none. Not gated on the tax strategy and not a historical record, so it can disagree with the served amounts; read totals.price_inclusive_of_tax for the flag that matches them. item_refunds_allowed: type: boolean subtotal: type: string transaction_fee: type: string enrollment_fee: type: string discount: type: string cart_token: type: - string - 'null' sub_total_in_currency: type: string tax_in_currency: type: string discount_in_currency: type: string payment_method: type: - object - 'null' description: >- Null when the order has no payment method and no recorded cash payment. Cash an admin recorded serves payment_type "cash", payment_title and details with the transaction_id and receipt_number. A stored card serves the flat card keys, id through logo_url. Every other integration (PayPal, Affirm, Bread, Klarna, wallets and the rest) serves payment_type, payment_title and details instead; Apple Pay, Google Pay and a card without a stored card also serve source. additionalProperties: true properties: id: type: - integer - 'null' description: The order's payment method id. Card only. card_id: type: integer description: Card only. full_name: type: - string - 'null' description: Cardholder name. Card only. month: type: - integer - 'null' description: Expiry month. Card only. year: type: - integer - 'null' description: Expiry year. Card only. number: type: string description: Masked card number, such as "**** **** **** 4242". Card only. last_four_digits: type: - string - 'null' description: Card only. first_six_digits: type: - string - 'null' description: Card only. default: type: - boolean - 'null' description: Whether this is the customer's default card. Card only. email: type: - string - 'null' description: Card only. Null for companies whose payment tokens are isolated. source: type: - string - 'null' description: The payment method's source, such as card or apple_pay. card_network: type: - string - 'null' description: >- Card network from the stored card, the payment method or the successful payment, titleized (Visa, Mastercard). Card only. card_type: type: - string - 'null' description: >- Card funding classification when known, such as debit. Card only. logo_url: type: string description: >- Card brand logo. Card only; other integrations serve it inside details. payment_type: type: - string - 'null' description: >- The integration, such as PayPal, Affirm or Credit Card; null when the payment method records no integration. Every integration but a stored card. payment_title: type: - string - 'null' description: >- Display title for the payment method. Every integration but a stored card. details: type: object additionalProperties: true description: >- Integration-specific details, such as a transaction id, status, amount and logo_url. Their keys depend on payment_type. Every integration but a stored card. payment_status: type: string is_cancellable: type: boolean is_refundable: type: boolean points_refunded: type: boolean cancel_context: type: - string - 'null' enum: - inflight_capture - no_payment - pending_hold - void_authorization - null description: >- Which warning to show before offering to cancel the order, or null for none. `inflight_capture` means a capture is in flight, so the order cannot be cancelled until it settles. Null when the order is cancelled or archived, or cannot be cancelled for any other reason. warehouse_name: type: - string - 'null' tax_exempt_at_order_time: type: boolean description: >- Whether the buyer was tax-exempt when the order was placed. Read from the order-time snapshot, so later changes to the buyer's tax_exempt flag do not alter it. False for legacy orders without a snapshot. sales_tax_id_at_order_time: type: - string - 'null' description: >- The buyer's sales tax ID captured when the order was placed, or null when the buyer had none (or the order pre-dates the snapshot). digital_only: type: boolean description: >- Whether the order contains only digital (non-physical) products. True for an order with no line items, which likewise has nothing to ship. rep: type: - object - 'null' refunds: type: array items: type: object country: type: - object - 'null' description: >- The order's country (its own country, else the ship-to address country, else the company default). Null when none resolves. properties: id: type: integer name: type: - string - 'null' iso: type: - string - 'null' description: 2-letter country code (ISO 3166-1 alpha-2) iso_name: type: - string - 'null' iso3: type: - string - 'null' description: 3-letter country code (ISO 3166-1 alpha-3) currency_code: type: - string - 'null' currency_symbol: type: - string - 'null' province_required: type: boolean description: Whether addresses in this country require a province or state tax_enabled: type: - boolean - 'null' price_inclusive_of_tax: type: boolean description: Whether this country's prices include tax price_inclusive_tax_name: type: string description: >- Display name of the tax included in the price (e.g. VAT, GST); empty string when unset tax_standard_rate: type: - number - 'null' description: Standard tax rate, as a percentage additionalProperties: false metafields: type: array items: type: object agreement_acceptances: type: array items: $ref: '#/components/schemas/AgreementAcceptance' status: type: - string - 'null' tax: type: string description: Decimal string. shipping: type: string description: >- Quoted shipping rate, as a decimal string. The stored quote's price when one exists, else the order's shipping amount. Not reduced by free shipping; `shipping_cost` is what was charged. shipping_cost: type: string description: >- Shipping amount actually charged, as a decimal string; "0.0" when the order has free shipping. `shipping` is the quoted rate when one was stored. required: - price_inclusive_of_tax - price_inclusive_tax_name - totals FailureEnvelopeResponse: description: >- The API's failure envelope for a client error. `data.error` carries the message. type: object required: - status - data properties: status: type: string enum: - fail data: type: object properties: error: $ref: '#/components/schemas/ErrorMessage' additionalProperties: $ref: '#/components/schemas/JsonValue' additionalProperties: false ValidationErrorsResponse: description: >- A record's validation errors, keyed by attribute (`base` for the record as a whole), each a list of messages. type: object additionalProperties: type: array items: type: string UnauthorizedResponse: type: object properties: message: type: string required: - message StandardForbiddenResponse: description: Common legacy forbidden response envelope. allOf: - $ref: '#/components/schemas/StandardErrorResponse' 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' TaxTotalsBreakdown: type: object additionalProperties: false description: >- Display-ready totals breakdown. Decomposes the inclusive-tax figures so clients render the net subtotal, item tax, shipping net and shipping VAT without re-deriving them. Each money component carries a raw boundary-rounded decimal string plus its currency-formatted `_in_currency` sibling. Deliberately omits a grand total — the authoritative charge stays on the sibling total/amount fields. properties: gross_subtotal: type: string description: Catalog sum of line-item prices (customer display). gross_subtotal_in_currency: type: string description: gross_subtotal formatted in the order's currency. net_subtotal: type: string description: Items subtotal excluding embedded item tax. net_subtotal_in_currency: type: string description: net_subtotal formatted in the order's currency. item_tax: type: string description: Embedded tax attributable to the items. item_tax_in_currency: type: string description: item_tax formatted in the order's currency. shipping_net: type: string description: Shipping charge excluding embedded shipping tax. shipping_net_in_currency: type: string description: shipping_net formatted in the order's currency. shipping_tax: type: string description: Embedded tax attributable to shipping. shipping_tax_in_currency: type: string description: shipping_tax formatted in the order's currency. total_tax: type: string description: Combined item and shipping tax. total_tax_in_currency: type: string description: total_tax formatted in the order's currency. price_inclusive_of_tax: type: boolean description: >- Whether the served numbers carved tax out of the catalog prices. Gated on the resolved tax strategy, so it always agrees with these numbers. Not a historical record. The monetary amounts in this breakdown are history-safe: they are split from the line tax and the combined tax total persisted with the order, never from today's rate. This inclusive-versus-exclusive classification is not: it is resolved from the CURRENT company/country tax configuration, not the configuration in force on the order date. If a company changes its tax strategy or a country toggles inclusive pricing, this flag — and with it how the persisted tax is decomposed across `net_subtotal`, `item_tax`, `shipping_net` and `shipping_tax` — changes for orders that were already placed. Do not read it as how the order was taxed at the time it was placed. tax_label: type: - string - 'null' description: The resolved tax-line label (e.g. "VAT"), or null. required: - gross_subtotal - gross_subtotal_in_currency - net_subtotal - net_subtotal_in_currency - item_tax - item_tax_in_currency - shipping_net - shipping_net_in_currency - shipping_tax - shipping_tax_in_currency - total_tax - total_tax_in_currency - price_inclusive_of_tax - tax_label AgreementAcceptance: type: object description: >- One recorded acceptance of an agreement, with the agreement text as it stood when accepted. properties: id: type: integer description: The acceptance record's ID. agreement_id: type: integer description: The accepted agreement's ID. title: type: - string - 'null' description: The agreement's current title. required: type: boolean description: Whether the agreement was required when it was accepted. accepted_at: type: string format: date-time description: When the agreement was accepted. acceptance_context: type: string enum: - checkout - company_onboarding - enrollment - login description: Where the agreement was accepted. acceptance_method: type: string enum: - customer - agent_confirmed description: >- How the agreement was accepted. `customer` means the customer accepted it directly. `agent_confirmed` means an admin placing the order confirmed the customer's agreement on their behalf. order_id: type: - integer - 'null' description: >- The order the agreement was accepted with, or null when it was accepted outside an order (at login or company onboarding). content_snapshot: type: - string - 'null' description: The agreement's HTML as it stood when accepted. required: - id - agreement_id - title - required - accepted_at - acceptance_context - acceptance_method - order_id ErrorMessage: description: An API error message represented as text or structured JSON. anyOf: - type: string - $ref: '#/components/schemas/ErrorBag' - type: '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' 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.