> ## Documentation Index > Fetch the complete documentation index at: https://docs.fluid.app/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > For new direct REST integrations, use the v2026-04 surfaces. The @fluid-app FairShare SDK continues to use its own published public-v2025-06 contract. > Authenticate with the header Authorization: Bearer ; public storefront read endpoints require no auth. > To sign a new merchant up for Fluid programmatically, call POST https://api.fluid.app/api/company with no credentials, as described in /api/agent-signup. Do not automate the signup form or book a demo. The merchant must open the emailed sign-in link and create an API token before authenticated calls are possible. > 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. /api/company/v1 and /api/v1/... paths are documented in no spec here and must never be used (/api/v1.1/... is distinct and documented in company-v0). Use page/per_page offset pagination only where a spec documents it — in practice the unversioned company-v0 admin surface; every versioned surface uses cursor pagination. > Navigation menu management is documented in themes/navigation-menus. These unversioned admin endpoints (/api/menus and nested menu_items) are verified against the implementation but are not yet in the synced OpenAPI specs. Use that reference for menu payloads and its flat page/per_page pagination; missing spec coverage does not make these endpoints unavailable. > The OpenAPI specs under api-reference/ are the authoritative contracts; prefer them over prose when in doubt. api-reference/storefront-v2026-04.yaml covers the v2026-04 storefront surface (/api/v202604/... paths); api-reference/checkout-v2026-04.yaml covers the v2026-04 checkout surface (/api/checkout/v2026-04/... paths — carts, cart auth, discounts, items, subscriptions, orders, enrollments, and store config); api-reference/public-v2025-06.yaml covers the Public SDK surface used by the @fluid-app FairShare SDK, including its parallel cart lifecycle, browser integrations, versioned payment callbacks, unversioned public utilities, and the cart price-override operation; api-reference/payment-v2026-04.yaml covers the v2026-04 payment gateway admin surface (/api/payment/v2026-04/... paths, bearer-authenticated — gateway CRUD, gateway purchase/authorize/$0-verify, transaction list/show and capture/void/credit, and merchant payment configuration); api-reference/payments-v2026-04.yaml covers the v2026-04 cart payment surface (/api/payments/v2026-04/carts/{cart_token}/... paths, authenticated by the cart token in the path with no bearer — payment-method selection, VGS card tokenization, 3D Secure verification, and PayPal/Braintree/Klarna/Apple Pay flows); api-reference/commerce-v2026-04.yaml covers the v2026-04 commerce order-editing surface (/api/v202604/orders/{order_id}/edits paths, bearer-authenticated — post-checkout order edits that atomically insert items and add adjustments/discounts, with an optional dry-run preview); api-reference/webhooks-v0.yaml covers the unversioned webhooks surface (/api/... paths — webhook registration, delivery payloads, callback registrations, company events, and webhook/callback schemas); api-reference/company-v0.yaml covers the legacy unversioned company admin surface (/api/... paths, bearer-authenticated — company settings and management, customers, users, roles, subscription plans, subscription bundles, subscriptions, media, pages, catch-ups, inventory levels, domains, agreements, and admin order actions). company-v0 caveats: it is the legacy v0 admin contract and its lists use flat page/per_page offset pagination, which is expected there despite the general cursor-pagination rule; where an operation exists in both company-v0 and a versioned spec, prefer the versioned spec — the subscriptions lifecycle (list/create/show/update, cancel, pause, reactivate, resume, retry, skip, failed-cycle-waiver, discounts) and subscription bundles are superseded by checkout-v2026-04, and company pages/media CRUD plus the public pages, categories, products, and media list endpoints are superseded by storefront-v2026-04. Subscription plan management (/api/subscription_plans, resource-wrapped {"subscription_plan": {...}} bodies) exists only in company-v0. api-reference/members-v2025-06.yaml covers the v2025-06 unified Member identity surface (/api/v2025-06/members/... paths, bearer-authenticated — member list/create/show/update, lookup by email/username/external_id/legacy_customer_id, member-type assignment, and the sponsor genealogy read). Prefer it over the customers and reps surfaces when the member type matters: /customers does not serialize member_type. api-reference/analytics-v2026-04.yaml covers the v2026-04 Home dashboard analytics surface (/api/v202604/analytics/dashboard/... paths, bearer-authenticated — read-only endpoints for the Home > Overview, Home > Live, and Home > Field tabs, each accepting an optional country ISO alpha-2 query param that scopes aggregations to a single country). > api-reference/analytics-v0.yaml covers the unversioned analytics surface that backs the fluid-admin Traffic tab (/api/analytics/... and /api/analytics/traffic/... paths, bearer-authenticated — the legacy shares/views/visitors summary plus traffic overview, ranked campaigns, sources, geographies, flows, and per-rep breakdown, all sharing one reporting-period contract). > Successful responses wrap the resource payload alongside a top-level integer status and a meta object. > Portal Definition authoring edits and synchronizes the portal JSON resource graph. Widget Package authoring builds either a company-owned or Droplet-owned Remote DOM package. These are separate contracts; do not imply that one defines the other. > For Widget Package worker code, use only @fluid-app/portal-sdk/widgets/worker. Use only the Portal Definition and Widget Package workflows and public entry points documented here; do not infer support for undocumented surfaces. > Every portal function and declarative capability used by a widget must appear in that widget's uses array. Use the same typed function value in uses; do not invent capability-name strings. > Widget styling must use the portal's semantic theme variables for colors, typography, spacing, radii, borders, focus, and charts whenever a token represents the visual decision. Do not create a separate light or dark palette or duplicate theme controls as widget properties. > Prefer worker-safe Fluid UI components exported by @fluid-app/portal-sdk/widgets/worker when they fit the interaction. When no exported component fits, use semantic HTML, accessible behavior, and the portal theme variables. > A Portal Definition push updates the remote working definition. A portal version is an immutable snapshot, and activation is a separate live release operation. # Create a company country > Add a new country to the company configuration ## OpenAPI ````yaml /api-reference/settings-v0.yaml post /api/settings/company_countries openapi: 3.1.0 info: title: Fluid Settings API version: v0 contact: email: support@fluid.app license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.fluid.app security: [] paths: /api/settings/company_countries: post: tags: - countries summary: Create a company country description: Add a new country to the company configuration operationId: settings_v0_create_company_country requestBody: content: application/json: schema: $ref: >- #/components/schemas/CreateCompanyCountryRequestBodyApplicationJsonSchema example: company_country: country_id: 38 currency: CAD warehouse_id: 3120 handling_fee: 4 default: false settlement_currency: USD tax_class: fluid requires_3ds: false responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/CreateCompanyCountryResponse200ApplicationJsonSchema example: company_country: id: 48214 currency: CAD base_shipping: '7.95' default: false pause_incomplete_enrollment: false handling_fee: 4 updated_at: '2026-09-11T09:05:17Z' settlement_currency: USD entity_legally_registered: true tax_inclusive_pricing: null tax_name: null payment_method_priority: null country_defaults: tax_inclusive: false tax_name: null country: id: 38 name: Canada iso: CA tax_enabled: true price_inclusive_of_tax: false price_inclusive_tax_name: null iso_name: CANADA iso3: CAN currency_code: CAD currency_symbol: $ province_required: true tax_standard_rate: null entity: null test_mode: false test_mode_resolvable: null revision: >- 3f7a1c9e5b2d8f4a6c0e2b4d6f8a1c3e5b7d9f0a2c4e6b8d1f3a5c7e9b0d2f4a checkout_requires_terms: null tax_invoice_required: null legal_settings: null address_fields: null require_gaiyo_shomen_in_enrollment: false tax_apply: false tax_business_id: null tax_apply_discounted_rates: false tax_auto_send_invoice: false apply_shipping_tax: true avalara_shipping_tax_code: FR020100 customs: null use_company_default_tax_settings: true use_company_avalara_tax_settings: false use_company_manual_tax_settings: false use_company_webhook_tax_settings: false use_custom_avalara_tax_settings: false custom_avalara_user_name: null custom_avalara_password: null use_custom_avalara_product_tax_code: false tax_option: avalara tax_strategy: avalara tax_class: fluid effective_tax_class: fluid avalara_commit_enabled: false tax_callback_registration_id: null tax_callback_registration: null warehouse: id: 3120 name: Scranton Warehouse active: true external_id: SCR-01 metadata: dock: B address: id: 90417 name: Scranton Warehouse address1: 1725 Slough Avenue address2: null address3: null city: Scranton state: PA subdivision_code: US-PA postal_code: '18505' country_code: US default: true first_name: Darryl last_name: Philbin company: id: 1405 name: Dunder Mifflin Paper Company requires_3ds: false warnings: [] meta: request_id: c4f1b9e2-7a3d-4e8b-9f21-5d6a0b3e8c47 timestamp: '2026-09-14T15:32:08Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '422': description: Validation failed content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearer_auth: [] components: schemas: CreateCompanyCountryRequestBodyApplicationJsonSchema: type: object required: - company_country properties: seed_legacy_defaults: type: - boolean - 'null' description: >- False skips the default country agreements and default forms a new country normally receives, for a caller that creates its own selection. The Japan gaiyo shomen enrollment form is still created where required. Omitted or true keeps the defaults. company_country: type: object required: - country_id properties: country_id: type: integer currency: type: string warehouse_id: type: integer handling_fee: type: number default: type: boolean tax_business_id: type: string custom_avalara_user_name: type: string custom_avalara_password: type: string tax_strategy: type: string tax_class: type: string require_gaiyo_shomen_in_enrollment: type: boolean settlement_currency: type: string entity_id: type: integer entity_legally_registered: type: boolean tax_inclusive_pricing: type: - boolean - 'null' tax_name: type: - string - 'null' tax_callback_registration_id: type: - integer - 'null' requires_3ds: type: boolean payment_method_priority: type: - array - 'null' items: type: string description: >- Ordered integration type names checkout ranks payment methods by for this country (for example Paypal, CreditCard); unranked methods keep their default order after them. Null clears the order. checkout_requires_terms: type: - boolean - 'null' description: >- Whether checkout requires accepting terms in this country. Null inherits the country setting. tax_invoice_required: type: - boolean - 'null' description: >- Whether orders in this country need a tax invoice. Null inherits the country setting. legal_settings: $ref: '#/components/schemas/CompanyCountryLegalSettings' address_fields: type: - array - 'null' description: >- The address fields checkout collects for this country, in order. Null uses the default fields for the country; an empty list collects none. A field cannot be required and hidden, and a field may appear once. items: $ref: '#/components/schemas/CompanyCountryAddressField' CreateCompanyCountryResponse200ApplicationJsonSchema: type: - object - 'null' properties: company_country: $ref: '#/components/schemas/SettingsCompanyCountry' warnings: type: array description: Non-blocking configuration warnings produced by the write. items: type: object required: - code - country_iso - message properties: code: type: string enum: - test_mode_no_gateway country_iso: type: string message: type: string meta: type: - object - 'null' properties: request_id: type: - string - number - integer - 'null' timestamp: type: - string - number - integer - 'null' UnauthorizedResponse: type: object properties: message: type: string required: - message ErrorResponse: type: object required: - error_message - errors - meta properties: error_message: type: string errors: $ref: '#/components/schemas/ErrorBag' meta: $ref: '#/components/schemas/Meta' CompanyCountryLegalSettings: type: - object - 'null' additionalProperties: false description: >- Legal facts checkout and order documents disclose for this country. Null when the company has set none. properties: cooling_off_period_days: type: - integer - 'null' minimum: 0 warranty_period_months: type: - integer - 'null' minimum: 0 cookie_consent_required: type: - boolean - 'null' recurring_subscription_disclosure_required: type: - boolean - 'null' order_button_label: type: - string - 'null' marketing_consent_mode: type: - string - 'null' enum: - opt_in - opt_out - null CompanyCountryAddressField: type: object additionalProperties: false required: - field - visible - required properties: field: type: string minLength: 1 pattern: \S description: The address attribute, for example postal_code or phone. visible: type: boolean required: type: boolean description: >- A required field must also be visible, and must be one an checkout form renders (name, address1, address2, city, state, postal_code, country_code or phone). Any other field may be listed only as optional. local_label: type: - string - 'null' column_width: type: - string - 'null' enum: - full - half - third - null placeholder: type: - string - 'null' SettingsCompanyCountry: title: CompanyCountry type: - object - 'null' properties: id: type: - integer - string - number - 'null' currency: type: - string - number - integer - 'null' base_shipping: default: '0.0' anyOf: - type: - number - string - integer - 'null' - type: - string - number - integer - 'null' default: type: - boolean - 'null' test_mode: type: - boolean - 'null' description: Whether the country is configured for per-country test mode. test_mode_resolvable: type: - boolean - 'null' description: >- Whether the country's designated test gateway is usable. Null when test mode is off. pause_incomplete_enrollment: type: - boolean - 'null' handling_fee: type: - number - string - integer - 'null' updated_at: type: - string - number - integer - 'null' format: date-time settlement_currency: type: - string - number - integer - 'null' entity_legally_registered: type: - boolean - 'null' tax_inclusive_pricing: description: Tax-inclusive pricing setting for VAT-style markets. type: - boolean - 'null' tax_name: description: Tax name for explicit tax-inclusive pricing overrides type: - string - 'null' country_defaults: type: object properties: tax_inclusive: type: - boolean - 'null' tax_name: type: - string - 'null' country: $ref: '#/components/schemas/SettingsCompanyCountryCountry' entity: $ref: '#/components/schemas/SettingsCompanyEntity' tax_apply: type: - boolean - 'null' tax_business_id: type: - string - number - integer - 'null' tax_apply_discounted_rates: type: - boolean - 'null' tax_auto_send_invoice: type: - boolean - 'null' apply_shipping_tax: type: - boolean - 'null' avalara_shipping_tax_code: type: - string - number - integer - 'null' customs: description: >- DDP = Delivery Duty Paid, DAP = Delivered at Place (customer pays VAT/customs on delivery) type: - string - number - integer - 'null' use_company_default_tax_settings: type: - boolean - 'null' use_company_avalara_tax_settings: type: - boolean - 'null' use_company_manual_tax_settings: type: - boolean - 'null' use_company_webhook_tax_settings: type: - boolean - 'null' use_custom_avalara_tax_settings: type: - boolean - 'null' custom_avalara_user_name: type: - string - number - integer - 'null' custom_avalara_password: type: - string - number - integer - 'null' use_custom_avalara_product_tax_code: type: - boolean - 'null' tax_option: type: - string - number - integer - 'null' tax_strategy: type: - string - number - integer - 'null' tax_class: type: - string - number - integer - 'null' effective_tax_class: type: - string - number - integer - 'null' avalara_commit_enabled: type: - boolean - 'null' description: >- Whether paid orders shipping to this country are committed to the merchant's Avalara account as SalesInvoice documents tax_callback_registration_id: type: - integer - string - number - 'null' tax_callback_registration: type: - object - 'null' properties: id: type: - integer - 'null' uuid: type: - string - 'null' url: type: - string - 'null' country_codes: type: - array - 'null' items: type: string owner_type: type: - string - 'null' droplet: type: - object - 'null' properties: uuid: type: - string - 'null' name: type: - string - 'null' logo_url: type: - string - 'null' require_gaiyo_shomen_in_enrollment: description: >- Gaiyo Shomen is a company overview document required for certain business transactions in Japan. When enabled, this setting mandates that companies provide this document during enrollment flows. Only applicable for Japan country configurations. type: - boolean - 'null' requires_3ds: type: - boolean - 'null' payment_method_priority: type: - array - 'null' items: type: string description: >- Ordered integration type names checkout ranks payment methods by for this country; unranked methods keep their default order after them. Null when the company has set no order. revision: type: string description: >- A digest of the country's stored values. Send it back as expected_revision on an update to refuse the write when someone else changed the country since it was loaded. Treat it as opaque. checkout_requires_terms: type: - boolean - 'null' description: >- Whether checkout requires accepting terms in this country. Null inherits the country setting. tax_invoice_required: type: - boolean - 'null' description: >- Whether orders in this country need a tax invoice. Null inherits the country setting. legal_settings: $ref: '#/components/schemas/CompanyCountryLegalSettings' address_fields: type: - array - 'null' description: >- The address fields checkout collects for this country, in order. Null means the default fields for the country apply; an empty list collects none. items: $ref: '#/components/schemas/CompanyCountryAddressField' warehouse: $ref: '#/components/schemas/SettingsCompanyCountryWarehouse' company: title: Company type: - object - 'null' properties: id: type: - integer - string - number - 'null' name: type: - string - number - integer - '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 properties: request_id: type: - string - 'null' timestamp: type: string format: date-time SettingsCompanyCountryCountry: title: Country type: - object - 'null' properties: id: type: - integer - string - number - 'null' name: type: - string - number - integer - 'null' iso: description: 2-letter country code (ISO 3166-1 alpha-2) type: - string - number - integer - 'null' tax_enabled: type: - boolean - 'null' price_inclusive_of_tax: description: Whether this country's prices are inclusive of tax type: - boolean - 'null' price_inclusive_tax_name: description: The display name of the tax included in the price (e.g., VAT, GST) type: - string - number - integer - 'null' iso_name: type: - string - number - integer - 'null' iso3: description: 3-letter country code (ISO 3166-1 alpha-3) type: - string - number - integer - 'null' currency_code: type: - string - number - integer - 'null' currency_symbol: type: - string - number - integer - 'null' province_required: description: Whether this country requires a province/state in addresses type: - boolean - 'null' tax_standard_rate: description: Standard tax rate (percent) used for inclusive-pricing countries type: - number - 'null' SettingsCompanyEntity: title: Company::Entity type: - object - 'null' properties: id: type: - integer - string - number - 'null' legal_name: type: - string - number - integer - 'null' classification: type: - string - number - integer - 'null' trading_name: type: - string - number - integer - 'null' country_iso: type: - string - number - integer - 'null' address1: type: - string - number - integer - 'null' address2: type: - string - number - integer - 'null' city: type: - string - number - integer - 'null' province: type: - string - number - integer - 'null' postal_code: type: - string - number - integer - 'null' registration_number: type: - string - number - integer - 'null' date_of_incorporation: type: - string - number - integer - 'null' primary_mcc: type: - integer - string - number - 'null' secondary_mcc: type: - integer - string - number - 'null' phone_country_code: type: - string - number - integer - 'null' phone: type: - string - number - integer - 'null' website: type: - string - number - integer - 'null' tax_id: type: - string - number - integer - 'null' principal_same_as_registered_address: type: - boolean - 'null' primary: type: - boolean - 'null' status: type: - string - number - integer - 'null' business_registration_file_url: type: - string - number - integer - 'null' business_registration_file_name: type: - string - number - integer - 'null' business_license_file_url: type: - string - number - integer - 'null' business_license_file_name: type: - string - number - integer - 'null' articles_of_incorporation_file_url: type: - string - number - integer - 'null' articles_of_incorporation_file_name: type: - string - number - integer - 'null' last_3_months_processing_statements: type: - array - 'null' items: $ref: '#/components/schemas/JsonValue' business_identification_number: type: - string - number - integer - 'null' w_9_file_url: type: - string - number - integer - 'null' w_9_file_name: type: - string - number - integer - 'null' business_registration_certificate_file_url: type: - string - number - integer - 'null' business_registration_certificate_file_name: type: - string - number - integer - 'null' created_at: type: - string - number - integer - 'null' updated_at: type: - string - number - integer - 'null' registered_address: $ref: '#/components/schemas/SettingsEntityAddress' principal_address: $ref: '#/components/schemas/SettingsEntityAddress' SettingsCompanyCountryWarehouse: title: Warehouse type: - object - 'null' properties: id: type: - integer - string - number - 'null' name: type: - string - number - integer - 'null' active: type: - boolean - 'null' external_id: type: - string - number - integer - 'null' metadata: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' country: $ref: '#/components/schemas/SettingsWarehouseCountry' address: $ref: '#/components/schemas/SettingsWarehouseAddress' ErrorValue: description: A validation or API error value. anyOf: - type: string - type: array items: type: string - type: object additionalProperties: $ref: '#/components/schemas/JsonValue' 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' SettingsEntityAddress: title: Address type: - object - 'null' properties: id: type: - integer - string - number - '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' subdivision_code: type: - string - number - integer - 'null' postal_code: type: - string - number - integer - 'null' country_code: type: - string - number - integer - 'null' SettingsWarehouseCountry: title: Country type: - object - 'null' properties: id: type: - integer - string - number - 'null' name: type: - string - number - integer - 'null' iso: description: 2-letter country code (ISO 3166-1 alpha-2) type: - string - number - integer - 'null' tax_enabled: type: - boolean - 'null' price_inclusive_of_tax: description: Whether this country's prices are inclusive of tax type: - boolean - 'null' price_inclusive_tax_name: description: The display name of the tax included in the price (e.g., VAT, GST) type: - string - number - integer - 'null' iso_name: type: - string - number - integer - 'null' iso3: description: 3-letter country code (ISO 3166-1 alpha-3) type: - string - number - integer - 'null' currency_code: type: - string - number - integer - 'null' currency_symbol: type: - string - number - integer - 'null' province_required: description: Whether this country requires a province/state in addresses type: - boolean - 'null' tax_standard_rate: description: Standard tax rate (percent) used for inclusive-pricing countries type: - number - 'null' currency_details: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonValue' SettingsWarehouseAddress: title: Address 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' subdivision_code: type: - string - number - integer - 'null' postal_code: type: - string - number - integer - 'null' country_code: type: - string - number - integer - 'null' default: description: Use this address by default when there are multiple addresses type: - boolean - 'null' default: false first_name: type: - string - number - integer - 'null' last_name: type: - string - number - integer - 'null' securitySchemes: bearer_auth: type: http scheme: bearer description: Bearer token authentication ````