> ## 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 customer (PUT) > The PUT form of `PATCH /api/customers/{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/customers/{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/customers/{id}: put: tags: - customers summary: Update a customer (PUT) description: |- The PUT form of `PATCH /api/customers/{id}`. Both methods reach one update action, take the same body and return the same responses. Read that operation for the details. operationId: commerce_v0_update_customer_put parameters: - name: id in: path required: true description: Customer's Id schema: type: integer requestBody: $ref: '#/components/requestBodies/UpdateCustomer' responses: '200': $ref: '#/components/responses/UpdateCustomerOk' '401': $ref: '#/components/responses/Unauthorized' security: - bearer_auth: [] components: requestBodies: UpdateCustomer: content: application/json: schema: $ref: >- #/components/schemas/UpdateCustomerRequestBodyApplicationJsonSchema description: Request payload example: first_name: Holly last_name: Flax phone: '+15705550142' email_marketing: true notes: Prefers deliveries left with reception. default_address_attributes: address1: 412 Keystone Road address2: Apt 3 city: Scranton state: PA postal_code: '18505' country_code: US responses: UpdateCustomerOk: description: Success content: application/json: schema: $ref: '#/components/schemas/CompanyCustomerResponse' example: customer: id: 48213 full_name: Holly Flax email: holly.flax@dundermifflin.com created_at: '2026-09-02T14:18:37Z' user_company_id: 90517 metadata: loyalty_tier: gold referral_source: scranton-business-expo email_marketing: true sms_marketing: false account_id: DM-CUST-48213 phone: '+15705550142' external_id: crm-00048213 first_name: Holly last_name: Flax verified_email: true orders_count: 7 display_total_spent: $384.93 name: Holly Flax role: customer last_order_id: 771042 notes: Prefers deliveries left with reception. active: true total_spent: '384.93' customer_notes: - id: 5521 note: >- Asked to switch her standing order to the 24lb paper next quarter. customer_id: 48213 resource_id: 48213 resource_type: Customer created_at: '2026-09-14T10:05:12Z' user_company_id: 90012 user_company: id: 90012 first_name: Michael last_name: Scott full_name: Michael Scott email: michael.scott@dundermifflin.com image_url: >- https://cdn.fluid.app/avatars/dunder-mifflin/michael-scott.jpg default_address: id: 330918 name: Holly Flax address1: 412 Keystone Road address2: Apt 3 address3: null city: Scranton state: PA subdivision_code: PA postal_code: '18505' country_code: US phone: '+15705550142' country_num_code: 840 default: true addresses: - id: 330918 name: Holly Flax address1: 412 Keystone Road address2: Apt 3 address3: null city: Scranton state: PA subdivision_code: PA postal_code: '18505' country_code: US phone: '+15705550142' country_num_code: 840 default: true payment_methods: [] is_rep: false is_discarded: false tax_exempt: false sales_tax_id: null points: 1250 points_decimal: '1250.0000' attributable_rep: id: 90231 first_name: Dwight last_name: Schrute image_url: >- https://cdn.fluid.app/avatars/dunder-mifflin/dwight-schrute.jpg active_subscriptions_count: 1 inactive_subscriptions_count: 0 metafields: [] member_id: 019f4b2e-7c1a-7d3e-9a41-2f6b8c0d5e17 jwt: '' username: holly-flax rank: null language_code: en member_type_slug: customer legacy_user_company_id: 90517 legacy_customer_id: 48213 sponsor: id: 90231 first_name: Dwight last_name: Schrute image_url: >- https://cdn.fluid.app/avatars/dunder-mifflin/dwight-schrute.jpg external_id: rep-dwight-schrute username: dwight-schrute email: dwight.schrute@dundermifflin.com agreement_acceptances: - id: 18830 agreement_id: 412 required: true accepted_at: '2026-09-02T14:21:04Z' acceptance_context: checkout title: Terms of Service order_id: 771042 acceptance_method: customer content_snapshot: >- By placing an order with Dunder Mifflin Paper Company you agree to these terms of service. fluid_pay_default_address_id: null meta: request_id: c4b1e8f2-3a7d-4e19-9b62-5d0f7a2c8e41 timestamp: '2026-09-30T15:42:07Z' Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/StandardUnauthorizedResponse' schemas: UpdateCustomerRequestBodyApplicationJsonSchema: type: - object - 'null' properties: first_name: type: - string - number - integer - 'null' description: First name of customer last_name: type: - string - number - integer - 'null' description: Last name of customer email: type: - string - number - integer - 'null' description: Email of customer phone: type: - string - number - integer - 'null' description: Phone number of customer account_id: type: - string - number - integer - 'null' description: >- A unique Account Id for customer. If empty, one is generated by the system external_id: type: - string - number - integer - 'null' description: >- A unique External Id for customer that is used to identify them in external systems. Deprecated for new integrations: this v0 endpoint is superseded by PATCH /api/v2025-06/members/{member_id} (operationId admin_v2025_06_members_patch), which accepts the same external_id and is the actively-developed lane for member external IDs. The field and this endpoint remain fully supported for existing integrations; nothing about their behaviour changes. notes: type: - string - number - integer - 'null' description: Note for customer metadata: type: - object - 'null' description: >- A JSON object that can store any custom data structure. When provided, replaces all existing metadata data. additionalProperties: $ref: '#/components/schemas/JsonValue' default_address_attributes: $ref: '#/components/schemas/CompanyCustomerAddressRequest' customer_notes_attributes: type: - array - 'null' items: type: - object - 'null' properties: note: type: - string - number - integer - 'null' description: Customer Note to be attached to the customer metafields_attributes: type: - array - 'null' description: Metafields for custom data storage items: $ref: '#/components/schemas/CompanyMetafieldUpdateRequest' CompanyCustomerResponse: description: A single customer. type: object properties: customer: $ref: '#/components/schemas/CompanyCustomer' meta: $ref: '#/components/schemas/CompanyResponseMeta' StandardUnauthorizedResponse: description: Common legacy unauthorized response envelope. allOf: - $ref: '#/components/schemas/StandardErrorResponse' 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' CompanyCustomerAddressRequest: type: - object - 'null' properties: address1: type: - string - number - integer - 'null' address2: type: - string - number - integer - 'null' city: type: - string - number - integer - 'null' state: type: - string - number - integer - 'null' postal_code: type: - string - number - integer - 'null' country_id: type: - integer - string - number - 'null' description: Takes precedence over country_code if both are provided. country_code: type: - string - number - integer - 'null' description: >- country_id takes precedence if both country_id and country_code provided. name: type: - string - number - integer - 'null' default: type: - boolean - 'null' description: >- Sets the address as the default address for the customer; false by default CompanyMetafieldUpdateRequest: type: - object - 'null' properties: id: type: - integer - string - number - 'null' description: Metafield ID (for updates) namespace: type: - string - number - integer - 'null' description: Namespace for the metafield key: type: - string - number - integer - 'null' description: Key for the metafield value: description: Value for the metafield (type depends on value_type) value_type: type: - string - number - integer - 'null' description: Type of the metafield value _destroy: type: - boolean - 'null' description: Mark for deletion CompanyCustomer: description: >- A customer of the company. Every customer response carries the base fields. Some fields appear only on particular endpoints: `active_subscriptions_count`, `inactive_subscriptions_count`, `metafields`, `member_id` and `jwt` are added for company admins; `points` and `attributable_rep` are added by the detail, update and attributable-rep endpoints; the sponsor, rank, identity and agreement fields are added by the detail and update endpoints only. type: object properties: id: type: integer description: The customer id used in every `/api/customers/{id}` path. full_name: type: - string - 'null' description: The customer's full name. name: type: - string - 'null' description: The customer's display name. first_name: type: - string - 'null' description: The customer's first name. last_name: type: - string - 'null' description: The customer's last name. email: type: - string - 'null' description: The customer's email address, unique within the company. phone: type: - string - 'null' description: The customer's phone number. account_id: type: - string - 'null' description: >- The company-unique account id. Generated by Fluid when not supplied on create. external_id: type: - string - 'null' description: The customer's identifier in an external system. user_company_id: type: - integer - 'null' description: >- The customer's legacy member id, or null when the customer has no member record. created_at: type: - string - 'null' description: When the customer was created. metadata: type: - object - 'null' description: >- Arbitrary JSON metadata stored on the customer. An empty object when none is set. additionalProperties: $ref: '#/components/schemas/JsonValue' email_marketing: type: - boolean - 'null' description: Whether the customer accepts email marketing. sms_marketing: type: - boolean - 'null' description: Whether the customer accepts SMS marketing. verified_email: type: - boolean - 'null' description: Whether the customer has verified their email address. orders_count: type: - integer - 'null' description: Number of orders the customer has placed. total_spent: type: - number - string - 'null' description: Lifetime spend in the company's base currency, as a decimal. display_total_spent: type: - string - 'null' description: Lifetime spend formatted for display in the company's currency. last_order_id: type: - integer - 'null' description: Id of the customer's most recent order. role: type: - string - 'null' description: >- The customer's resolved role (`customer`, `preferred_customer`, `rep` or `admin`), or null when it resolves to none of these. notes: type: - string - 'null' description: Free-text notes stored on the customer. active: type: - boolean - 'null' description: Whether the customer is active. is_rep: type: - boolean - 'null' description: Whether the customer is also a rep. is_discarded: type: - boolean - 'null' description: Whether the customer has been deleted. tax_exempt: type: - boolean - 'null' description: Whether the customer is exempt from sales tax. sales_tax_id: type: - string - 'null' description: The customer's sales tax exemption id. customer_notes: type: - array - 'null' description: Notes attached to the customer. items: $ref: '#/components/schemas/CompanyCustomerNote' default_address: $ref: '#/components/schemas/CompanyCustomerAddress' addresses: type: - array - 'null' description: The customer's saved addresses, including the default address. items: $ref: '#/components/schemas/CompanyCustomerAddress' payment_methods: type: - array - 'null' description: The customer's saved payment methods. items: type: object properties: id: type: integer description: Payment method id. source: type: - string - 'null' description: Where the payment method came from. payment_title: type: - string - 'null' description: Display label for the payment method. logo_url: type: - string - 'null' description: Logo of the card network or wallet. company_id: type: - integer - 'null' description: Id of the company that owns the payment method. user_id: type: - integer - 'null' description: Id of the user the payment method belongs to. created_at: type: - string - 'null' description: When the payment method was saved. updated_at: type: - string - 'null' description: When the payment method was last updated. active_subscriptions_count: type: - integer - 'null' description: Number of active subscriptions. Company admins only. inactive_subscriptions_count: type: - integer - 'null' description: Number of inactive subscriptions. Company admins only. metafields: type: - array - 'null' description: >- Custom metafields stored on the customer, with their definitions. Company admins only. items: $ref: '#/components/schemas/CompanyMetafield' member_id: type: - string - 'null' description: >- UUID of the member record behind the customer. Bind a cart buyer with this value. jwt: type: - string - 'null' description: >- Always an empty string. Customer session tokens are never returned to admins. points: type: - number - 'null' description: The customer's loyalty points balance. points_decimal: type: string pattern: ^-?\d+\.\d{4}$ description: >- The points balance as an exact decimal string with four decimal places. `points` keeps the whole number. example: '120.0000' attributable_rep: type: - object - 'null' description: >- The rep credited with the customer's orders, or null when none is attributed. properties: id: type: integer description: The rep's member id. first_name: type: - string - 'null' last_name: type: - string - 'null' image_url: type: - string - 'null' description: The rep's avatar URL. sponsor: type: - object - 'null' description: The member who enrolled the customer, or null when none is recorded. properties: id: type: integer first_name: type: - string - 'null' last_name: type: - string - 'null' image_url: type: - string - 'null' external_id: type: - string - 'null' username: type: - string - 'null' email: type: - string - 'null' username: type: - string - 'null' description: The customer's member username. rank: type: - object - 'null' description: The customer's rank, or null when unranked. properties: id: type: integer name: type: - string - 'null' external_id: type: - string - 'null' language_code: type: - string - 'null' description: ISO code of the customer's preferred language. member_type_slug: type: - string - 'null' description: Slug of the member type behind the customer's role. legacy_user_company_id: type: - integer - 'null' description: The customer's legacy member id, or null when none exists. legacy_customer_id: type: - integer - 'null' description: The customer's legacy customer id. Equal to `id`. fluid_pay_default_address_id: type: - integer - 'null' description: >- Id of the address set as the customer's Fluid Pay wallet default. Company admins only. agreement_acceptances: type: - array - 'null' description: >- Agreements the customer accepted at checkout or enrollment, newest first. items: type: object properties: id: type: integer agreement_id: type: - integer - 'null' title: type: - string - 'null' description: The agreement title. required: type: - boolean - 'null' description: Whether the agreement was required. accepted_at: type: - string - 'null' description: When the agreement was accepted. acceptance_context: type: - string - 'null' description: Where the agreement was accepted. acceptance_method: type: string enum: - customer - agent_confirmed description: >- Whether the customer accepted directly or an agent confirmed on their behalf. order_id: type: - number - 'null' description: The order the acceptance was recorded against. content_snapshot: type: - string - 'null' description: The agreement text as it read when accepted. CompanyResponseMeta: type: - object - 'null' properties: total_count: type: - integer - string - number - 'null' total_pages: type: - integer - string - number - 'null' current_page: type: - integer - string - number - 'null' request_id: type: - string - number - integer - 'null' timestamp: type: - string - number - integer - 'null' 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' CompanyCustomerNote: type: - object - 'null' properties: id: type: - integer - string - number - 'null' description: Id of the customer note user_company_id: type: - integer - 'null' - string - number description: Id of UserCompany who created the customer note username: type: - string - 'null' - number - integer description: Username of the User who created the customer note customer_id: type: - integer - string - number - 'null' description: Id of Customer associated with the customer note note: type: - string - number - integer - 'null' description: Note of the customer note resource_type: type: - string - 'null' - number - integer description: Type of Resource attached with the customer note resource_id: type: - integer - 'null' - string - number description: Id of Resource specified in the `resource_type` field created_at: type: - string - number - integer - 'null' description: Time the customer note was created CompanyCustomerAddress: type: - object - 'null' properties: id: type: - integer - string - number - 'null' name: type: - string - number - integer - 'null' address1: type: - string - number - integer - 'null' address2: type: - string - number - integer - 'null' address3: type: - string - number - integer - 'null' city: type: - string - number - integer - 'null' state: type: - string - number - integer - 'null' postal_code: type: - string - number - integer - 'null' country_code: type: - string - number - integer - 'null' description: >- country_id takes precedence if both country_id and country_code provided. subdivision_code: type: - string - number - integer - 'null' default: type: - boolean - 'null' CompanyMetafield: title: LegacyMetafield type: - object - 'null' properties: id: type: - integer - string - number - 'null' namespace: description: >- A container for related metafields. Commonly used to group metafields by app or functionality. type: - string - number - integer - 'null' maxLength: 20 pattern: ^[a-zA-Z0-9_]+$ key: description: >- The unique identifier for the metafield within its namespace. Must be unique per namespace and owner. type: - string - number - integer - 'null' maxLength: 30 pattern: ^[a-zA-Z0-9_]+$ value: description: The actual data stored in the metafield. Type depends on value_type. anyOf: - type: - string - number - integer - 'null' - type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' value_type: description: >- The data type that defines how the value should be interpreted and validated. type: - string - number - integer - 'null' description: description: >- Optional human-readable description explaining the purpose of this metafield. type: - string - number - integer - 'null' owner_type: description: >- The type of resource that this metafield belongs to (polymorphic association). type: - string - number - integer - 'null' owner_id: description: The ID of the specific resource that this metafield belongs to. type: - integer - string - number - 'null' created_at: description: Timestamp when the metafield was created. type: - string - number - integer - 'null' format: date-time updated_at: description: Timestamp when the metafield was last updated. type: - string - number - integer - 'null' format: date-time metafield_definition: $ref: '#/components/schemas/CompanyMetafieldDefinition' 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. CompanyMetafieldDefinition: title: MetafieldDefinition type: - object - 'null' properties: id: type: - integer - string - number - 'null' company_id: description: The ID of the company that owns this metafield definition. type: - integer - string - number - 'null' namespace: description: >- A container for related metafield definitions. Used to group definitions by app or functionality. Must be unique within company and owner_resource. type: - string - number - integer - 'null' maxLength: 20 pattern: ^[a-zA-Z0-9_]+$ key: description: >- The unique identifier for the metafield definition within its namespace and owner_resource. Combined with namespace and owner_resource, this must be unique per company. type: - string - number - integer - 'null' maxLength: 30 pattern: ^[a-zA-Z0-9_]+$ name: description: >- Human-readable display name for the metafield definition, shown in admin interfaces and forms. type: - string - number - integer - 'null' maxLength: 100 description: description: >- Detailed explanation of what this metafield definition represents, how it should be used, and any special instructions for content creators. type: - string - number - integer - 'null' value_type: description: >- The data type that defines how metafield values should be validated, stored, and displayed. Determines which validation rules are available. type: - string - number - integer - 'null' validation_rules: description: >- JSON object containing validation constraints that will be applied to metafield values. Available rules depend on the value_type. type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' owner_resource: description: >- The type of resource (model class name) that metafields using this definition can be attached to. Must match the polymorphic owner_type. type: - string - number - integer - 'null' pinned: description: >- Whether this definition should be prominently displayed or prioritized in admin interfaces and forms. type: - boolean - 'null' default: false position: default: 0 description: >- Sort order for displaying this definition relative to others in the same category and owner_resource. Lower numbers appear first. type: - integer - string - number - 'null' locked: description: >- Whether this metafield definition is locked, preventing direct updates or deletions of metafields using this definition. type: - boolean - 'null' default: false created_at: description: Timestamp when the metafield definition was created. type: - string - number - integer - 'null' format: date-time updated_at: description: Timestamp when the metafield definition was last updated. type: - string - number - integer - 'null' format: date-time list_type: description: >- Whether this definition is for list-type metafields that store arrays of values. type: - boolean - 'null' reference_type: description: >- Whether this definition is for reference-type metafields that store references to other resources. type: - boolean - 'null' supported_validations: description: >- Array of validation rule names that are supported for this value_type. type: - array - 'null' items: $ref: '#/components/schemas/JsonValue' validation_description: description: >- Human-readable description of what the value_type represents and its constraints. type: - string - number - integer - 'null' category_ids: description: >- Array of category IDs that this metafield definition is associated with for organizational purposes. items: type: - integer - string - number - 'null' type: - array - 'null' 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.