> ## 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 <token>; 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.

# Show a bundle's per-price-type price grid

> The stored prices of one bundle product for every active price type and currency: the bundle's own rows (on its master variant), each fixed group's rows, and each in-kit item's override rows. Cells are sparse -- a price type and currency with nothing stored has no cell. Every cell carries a lock_token for the editor to send back on a write. Read-only and set-based (Retail::BundlePriceGridReader). Gated on products.view AND the bundle_pricing capability (the company is on the bundle pricing gate and writes catalog prices). Requires admin tier.



## OpenAPI

````yaml /api-reference/admin-v2025-06.yaml get /api/v2025-06/products/{product_id}/bundle-prices
openapi: 3.1.0
info:
  title: Fluid Admin v2025-06 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": "<message>"}`, before the operation runs. The refusal is
    documented here once rather than on each operation.
  version: v2025-06
  contact:
    email: support@fluid.app
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.fluid.app
security: []
tags:
  - name: orders
    description: >-
      Read an order's detail and journey, and preview the points a refund of a
      selection returns before it is sent.
    x-fluid-section: Commerce
  - name: payments-reports
    description: >-
      Report on a company's payments over a period: transaction volume and
      amount, gateway latency, and approval and error rates, overall or per
      payment account.
    x-fluid-section: Payments
  - name: feature-flags
    description: >-
      Read and change a company's feature flags, and, for root admins, read the
      flag catalogue with each flag's summary and description.
    x-fluid-section: Developers
  - name: tokens
    description: >-
      Create and manage the company's API credentials: partner and public
      tokens, and the scoped clients that replace them for a company on identity
      sign-in, and for every company once scoped client creation is switched on
      for all.
    x-fluid-section: Developers
  - name: products
    description: >-
      Products, variants and their prices, including the per-price-type price
      grid of a bundle product.
    x-fluid-section: Commerce
  - name: tiktok
    description: >-
      The company's TikTok Shop connection, its logistics warehouses, category
      tree, product listings, and orders.
    x-fluid-section: Sales channels
  - name: ads
    description: >-
      The ad accounts a company advertises from. List what a connected Meta
      Business token can see and pick the ad account, Facebook Page and
      Instagram account Fluid launches ads into. Campaigns themselves stay on
      Meta.
    x-fluid-section: Sales channels
  - name: members
    description: >-
      Members and the member types that group them, including the company's
      default shopper member type.
    x-fluid-section: Members
paths:
  /api/v2025-06/products/{product_id}/bundle-prices:
    get:
      tags:
        - products
      summary: Show a bundle's per-price-type price grid
      description: >-
        The stored prices of one bundle product for every active price type and
        currency: the bundle's own rows (on its master variant), each fixed
        group's rows, and each in-kit item's override rows. Cells are sparse --
        a price type and currency with nothing stored has no cell. Every cell
        carries a lock_token for the editor to send back on a write. Read-only
        and set-based (Retail::BundlePriceGridReader). Gated on products.view
        AND the bundle_pricing capability (the company is on the bundle pricing
        gate and writes catalog prices). Requires admin tier.
      operationId: admin_v2025_06_products_bundle_prices_show
      parameters:
        - name: product_id
          in: path
          required: true
          description: The bundle product's id or slug.
          schema:
            type: string
      responses:
        '200':
          description: The bundle's price grid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BundlePricesResponse'
              example:
                product_id: 4021
                pricing_enabled: true
                calculate_volume_from_items: false
                bundle_subscriptions: false
                recurring_enabled: false
                recurring_hidden_reason: recurring_off
                price_types:
                  - id: 0198b2c4-5d1e-7a3f-8b6c-2f4d9e1a7c30
                    name: Retail
                    system: true
                    tier_level: 0
                currency_codes:
                  - USD
                bundle:
                  variant_id: 8812
                  cells:
                    - pricing_tier_id: 0198b2c4-5d1e-7a3f-8b6c-2f4d9e1a7c30
                      currency_code: USD
                      price: '149.00'
                      compare_at_price: '179.00'
                      subscription_price: '134.10'
                      plan_overrides:
                        - subscription_plan_id: 31
                          subscription_price: '129.00'
                      cv: '60.00'
                      qv: '60.00'
                      creditable_points: 15
                      lock_token: >-
                        5b0f6c2a9d4e8f13a7c1e0b92d6f4a58c3e7b1d90a2f6c4e8b5d3a1f7c9e0b24
                      markets_in_sync: true
                      out_of_sync_market_ids: []
                      markets:
                        - market_id: 0198b2c4-5d1e-7a3f-8b6c-2f4d9e1a7c41
                          market_name: Default
                          price: '149.00'
                          compare_at_price: '179.00'
                          subscription_price: '134.10'
                          cv: '60.00'
                          qv: '60.00'
                          creditable_points: 15
                          lock_token: >-
                            3a9c1e7f5b2d8046c1e9a7b3d5f20846ae1c9b7d3f5a2e0846c1b9d7a5f3e2c0
                  markets:
                    - market_id: 0198b2c4-5d1e-7a3f-8b6c-2f4d9e1a7c41
                      market_name: Default
                      currency_codes:
                        - USD
                  read_fields:
                    - price
                    - cv
                    - qv
                    - creditable_points
                  read_roles:
                    0198b2c4-5d1e-7a3f-8b6c-2f4d9e1a7c30:
                      price: charged
                      subscription_price: recurring_pending
                      creditable_points: charged
                      cv: charged
                      qv: charged
                groups:
                  - id: 912
                    title: Starter essentials
                    group_type: included
                    pricing_type: fixed_price
                    cells:
                      - pricing_tier_id: 0198b2c4-5d1e-7a3f-8b6c-2f4d9e1a7c30
                        currency_code: USD
                        price: '99.00'
                        subscription_price: null
                        cv: '40.00'
                        qv: '40.00'
                        creditable_points: null
                        lock_token: >-
                          9c2e4a6b8d0f1a3c5e7b9d1f3a5c7e9b0d2f4a6c8e0b1d3f5a7c9e1b3d5f7a90
                    items:
                      - id: 5530
                        variant_available: true
                        variant_id: 8790
                        title: Daily greens
                        product_title: Daily greens
                        sku: GRN-001
                        cells: []
                        read_fields: []
                        read_roles:
                          0198b2c4-5d1e-7a3f-8b6c-2f4d9e1a7c30: {}
                    read_fields: []
                    read_roles:
                      0198b2c4-5d1e-7a3f-8b6c-2f4d9e1a7c30: {}
                totals:
                  0198b2c4-5d1e-7a3f-8b6c-2f4d9e1a7c30:
                    USD:
                      min: '149.00'
                      max: '149.00'
                status: 200
                meta:
                  request_id: 3f1c6a52-8d07-4b9e-a1c4-7e2d90b5f6a3
                  timestamp: '2026-10-06T13:28:41Z'
        '401':
          description: Missing or invalid credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '403':
          description: The caller is not admin tier or lacks products.view permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
        '404':
          description: No product with this id belongs to the current company.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: >-
            The bundle_pricing capability is off for this company, or the
            product is not a bundle.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StandardErrorResponse'
      security:
        - bearer_auth: []
components:
  schemas:
    BundlePricesResponse:
      type: object
      description: >-
        A bundle product's per-price-type price grid. The editor builds the full
        price type x currency matrix from price_types and currency_codes; cells
        are sparse. bundle is null when the product has no master variant.
        pricing_enabled is whether bundle-level pricing is on (otherwise the
        bundle is priced from its groups).
      required:
        - product_id
        - pricing_enabled
        - calculate_volume_from_items
        - bundle_subscriptions
        - recurring_enabled
        - recurring_hidden_reason
        - price_types
        - currency_codes
        - bundle
        - groups
        - totals
        - status
        - meta
      additionalProperties: false
      properties:
        product_id:
          type: integer
        pricing_enabled:
          type: boolean
        calculate_volume_from_items:
          type: boolean
          description: Whether the bundle's CV/QV is summed from its group items.
        bundle_subscriptions:
          type: boolean
          description: Whether the company's bundle subscriptions are on.
        recurring_enabled:
          type: boolean
          description: >-
            Whether recurring bundle pricing is enabled for the company; the
            editor makes the subscription price editable only then.
        recurring_hidden_reason:
          type:
            - string
            - 'null'
          enum:
            - recurring_off
            - forced_child_subscription
            - unavailable
            - null
          description: >-
            Why the subscription column is hidden; null while recurring_enabled
            is true. recurring_off means the company has recurring bundle
            pricing off; forced_child_subscription means a group or item forces
            a subscription; unavailable is any other refusal.
        price_types:
          type: array
          items:
            $ref: '#/components/schemas/CatalogPriceType'
        currency_codes:
          type: array
          items:
            type: string
        bundle:
          anyOf:
            - type: object
              required:
                - variant_id
                - cells
                - markets
                - read_fields
                - read_roles
              additionalProperties: false
              properties:
                markets:
                  type: array
                  description: >-
                    The company's markets by position with the currencies each
                    sells, so a currency with no stored bundle price still
                    offers its markets for a per-market write.
                  items:
                    type: object
                    required:
                      - market_id
                      - market_name
                      - currency_codes
                    additionalProperties: false
                    properties:
                      market_id:
                        type: string
                        format: uuid
                      market_name:
                        type:
                          - string
                          - 'null'
                      currency_codes:
                        type: array
                        items:
                          type: string
                read_fields:
                  type: array
                  description: >-
                    The figures checkout or points read for this row in the
                    bundle's current configuration, at any price type.
                  items:
                    type: string
                    enum:
                      - price
                      - subscription_price
                      - cv
                      - qv
                      - creditable_points
                read_roles:
                  type: object
                  description: >-
                    Price type id => { field => charged | fallback |
                    recurring_pending }. A fallback is read only when another
                    figure is blank, zero or absent.
                  additionalProperties:
                    type: object
                    additionalProperties:
                      type: string
                      enum:
                        - charged
                        - fallback
                        - recurring_pending
                variant_id:
                  type: integer
                cells:
                  type: array
                  items:
                    $ref: '#/components/schemas/BundleLevelPriceCell'
            - type: 'null'
        groups:
          type: array
          items:
            $ref: '#/components/schemas/BundlePriceGroup'
        totals:
          type: object
          description: >-
            The bundle's saved-state total the storefront shows, price type id
            => currency code => { min, max } as decimal strings at the currency
            exponent, or null when the resolver refuses (no market sells the
            currency, a missing or unavailable price, or the bundle display gate
            is off). Stored rows only.
          additionalProperties:
            type: object
            additionalProperties:
              anyOf:
                - type: object
                  required:
                    - min
                    - max
                  additionalProperties: false
                  properties:
                    min:
                      type: string
                    max:
                      type: string
                - type: 'null'
        status:
          type: integer
          const: 200
        meta:
          $ref: '#/components/schemas/Meta'
    UnauthorizedResponse:
      type: object
      properties:
        message:
          type: string
        error_message:
          type: string
        errors:
          $ref: '#/components/schemas/ErrorBag'
        meta:
          $ref: '#/components/schemas/Meta'
    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'
    ErrorResponse:
      type: object
      required:
        - error_message
        - errors
        - meta
      properties:
        error_message:
          type: string
        errors:
          $ref: '#/components/schemas/ErrorBag'
        meta:
          $ref: '#/components/schemas/Meta'
    CatalogPriceType:
      type: object
      description: >-
        An active (non-archived) Company::PricingTier as the catalog price read
        API exposes it. `system` mirrors Company::PricingTier#system?
        (tier_level < 100) rather than a stored column.
      required:
        - id
        - name
        - system
        - tier_level
      additionalProperties: false
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        system:
          type: boolean
        tier_level:
          type: integer
    BundleLevelPriceCell:
      type: object
      description: >-
        One stored (price type, currency) cell of the bundle itself: the
        one-time and plan-less subscription rows of its master variant. A cell
        can span a row in each market carrying that price type and currency;
        markets_in_sync is false when they differ (the figures are the first
        market's row) and out_of_sync_market_ids names the markets that differ
        or have no list or row for it (a market whose region supports the
        currency counts). subscription_price is the plan-less subscription row;
        plan_overrides are read-only plan-scoped rows, which win for their plan.
        lock_token digests every expected market slot. markets holds each
        participating market's own figures and lock_token, for editing one
        market on its own (market_id on a write).
      required:
        - pricing_tier_id
        - currency_code
        - price
        - compare_at_price
        - subscription_price
        - cv
        - qv
        - creditable_points
        - lock_token
        - markets_in_sync
        - out_of_sync_market_ids
        - plan_overrides
        - markets
      additionalProperties: false
      properties:
        pricing_tier_id:
          type: string
          format: uuid
        currency_code:
          type: string
        price:
          type:
            - string
            - 'null'
          format: decimal
        compare_at_price:
          type:
            - string
            - 'null'
          format: decimal
        subscription_price:
          type:
            - string
            - 'null'
          format: decimal
        cv:
          type:
            - string
            - 'null'
          format: decimal
        qv:
          type:
            - string
            - 'null'
          format: decimal
        creditable_points:
          type:
            - integer
            - 'null'
        lock_token:
          type: string
          description: >-
            Opaque digest of the identity and version of every row backing the
            cell. Send it back on a write; any insert, delete or edit of a
            backing row changes it.
        plan_overrides:
          type: array
          items:
            type: object
            required:
              - subscription_plan_id
              - subscription_price
            additionalProperties: false
            properties:
              subscription_plan_id:
                type: integer
              subscription_price:
                type: string
                format: decimal
        out_of_sync_market_ids:
          type: array
          items:
            type: string
            format: uuid
        markets_in_sync:
          type: boolean
        markets:
          type: array
          items:
            type: object
            required:
              - market_id
              - market_name
              - price
              - compare_at_price
              - subscription_price
              - cv
              - qv
              - creditable_points
              - lock_token
            additionalProperties: false
            properties:
              market_id:
                type: string
                format: uuid
              market_name:
                type:
                  - string
                  - 'null'
              price:
                type:
                  - string
                  - 'null'
                format: decimal
              compare_at_price:
                type:
                  - string
                  - 'null'
                format: decimal
              subscription_price:
                type:
                  - string
                  - 'null'
                format: decimal
              cv:
                type:
                  - string
                  - 'null'
                format: decimal
              qv:
                type:
                  - string
                  - 'null'
                format: decimal
              creditable_points:
                type:
                  - integer
                  - 'null'
              lock_token:
                type: string
                description: >-
                  Opaque digest of this market's rows alone. Send it back with
                  market_id on a per-market write.
    BundlePriceGroup:
      type: object
      description: A bundle group, its stored cells (fixed groups), and its items.
      required:
        - id
        - title
        - group_type
        - pricing_type
        - cells
        - items
        - read_fields
        - read_roles
      additionalProperties: false
      properties:
        id:
          type: integer
        title:
          type: string
        group_type:
          type: string
        pricing_type:
          type: string
          enum:
            - fixed_price
            - dynamic_price
        cells:
          type: array
          items:
            $ref: '#/components/schemas/BundlePriceCell'
        market_cells:
          type: array
          description: >-
            Present only when the target has market rows. Each is a complete
            cell of its own for the market named by market_id, replacing the
            cell of the same price type and currency in cells for that market.
          items:
            $ref: '#/components/schemas/BundlePriceCell'
        markets_in_sync:
          type: boolean
          description: Present with market_cells; false while any market row exists.
        collapse_tokens:
          type: array
          description: >-
            Present with market_cells. One entry per price type and currency
            that has market rows: the lock_token a same_in_every_market cell
            must send. It covers the market-less row and every market row.
          items:
            type: object
            required:
              - pricing_tier_id
              - currency_code
              - lock_token
            additionalProperties: false
            properties:
              pricing_tier_id:
                type: string
              currency_code:
                type: string
              lock_token:
                type:
                  - string
                  - 'null'
        items:
          type: array
          items:
            $ref: '#/components/schemas/BundlePriceItem'
        subscription_price_ignored_at_checkout:
          type: boolean
          description: >-
            Present only while recurring bundle pricing is enabled and bundle
            pricing is turned on for this product. True when this row stores a
            subscription price that checkout ignores, since only the
            bundle-level subscription price is charged.
        read_fields:
          type: array
          description: >-
            The figures checkout or points read for this row in the bundle's
            current configuration, at any price type.
          items:
            type: string
            enum:
              - price
              - subscription_price
              - cv
              - qv
              - creditable_points
        read_roles:
          type: object
          description: >-
            Price type id => { field => charged | fallback | recurring_pending
            }. A fallback is read only when another figure is blank, zero or
            absent.
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              enum:
                - charged
                - fallback
                - recurring_pending
    Meta:
      type: object
      properties:
        request_id:
          type:
            - string
            - 'null'
        timestamp:
          type: string
          format: date-time
        pagination:
          type: object
          description: >-
            Rotulus cursor-pagination metadata (Api::MetaPagination#to_h),
            present on cursor-paginated responses such as GET
            /api/v2025-06/prices. total_count is only present when the endpoint
            opts into a total count.
          properties:
            cursor:
              type:
                - string
                - 'null'
            limit:
              type: integer
            prev_cursor:
              type:
                - string
                - 'null'
            next_cursor:
              type:
                - string
                - 'null'
            total_count:
              type: integer
    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'
    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'
    BundlePriceCell:
      type: object
      description: >-
        One stored (price type, currency) cell of a bundle group or in-kit item.
        Amounts are decimal strings at the currency's exponent, null when the
        row leaves the field blank (a blank amount falls back to the plan, the
        item sum or the catalog -- see the resolvers). A group cell's price is
        null when the row holds volumes, points or a subscription price but no
        one-time price; that is "no price", never 0, and a checkout that needs
        it is refused. lock_token is the row's lock_token.
      required:
        - pricing_tier_id
        - currency_code
        - price
        - subscription_price
        - cv
        - qv
        - creditable_points
        - lock_token
      additionalProperties: false
      properties:
        pricing_tier_id:
          type: string
          format: uuid
        currency_code:
          type: string
        price:
          type:
            - string
            - 'null'
          format: decimal
        subscription_price:
          type:
            - string
            - 'null'
          format: decimal
        cv:
          type:
            - string
            - 'null'
          format: decimal
        qv:
          type:
            - string
            - 'null'
          format: decimal
        creditable_points:
          type:
            - integer
            - 'null'
        lock_token:
          type: string
          description: >-
            Opaque digest of the identity and version of every row backing the
            cell. Send it back on a write; any insert, delete or edit of a
            backing row changes it.
        market_id:
          type: string
          description: >-
            Present only on a market cell (in market_cells), naming the market
            whose row this is.
    BundlePriceItem:
      type: object
      description: >-
        A bundle group item and its stored in-kit override cells. When the
        item's variant is not this company's (or is gone), variant_available is
        false and variant_id, title, product_title and sku are null.
      required:
        - id
        - variant_available
        - variant_id
        - title
        - product_title
        - sku
        - cells
        - read_fields
        - read_roles
      additionalProperties: false
      properties:
        id:
          type: integer
        variant_available:
          type: boolean
        variant_id:
          type:
            - integer
            - 'null'
        title:
          type:
            - string
            - 'null'
        product_title:
          type:
            - string
            - 'null'
          description: The title of the item's variant's product.
        sku:
          type:
            - string
            - 'null'
        cells:
          type: array
          items:
            $ref: '#/components/schemas/BundlePriceCell'
        market_cells:
          type: array
          description: >-
            Present only when the target has market rows. Each is a complete
            cell of its own for the market named by market_id, replacing the
            cell of the same price type and currency in cells for that market.
          items:
            $ref: '#/components/schemas/BundlePriceCell'
        markets_in_sync:
          type: boolean
          description: Present with market_cells; false while any market row exists.
        collapse_tokens:
          type: array
          description: >-
            Present with market_cells. One entry per price type and currency
            that has market rows: the lock_token a same_in_every_market cell
            must send. It covers the market-less row and every market row.
          items:
            type: object
            required:
              - pricing_tier_id
              - currency_code
              - lock_token
            additionalProperties: false
            properties:
              pricing_tier_id:
                type: string
              currency_code:
                type: string
              lock_token:
                type:
                  - string
                  - 'null'
        subscription_price_ignored_at_checkout:
          type: boolean
          description: >-
            Present only while recurring bundle pricing is enabled and bundle
            pricing is turned on for this product. True when this row stores a
            subscription price that checkout ignores, since only the
            bundle-level subscription price is charged.
        read_fields:
          type: array
          description: >-
            The figures checkout or points read for this row in the bundle's
            current configuration, at any price type.
          items:
            type: string
            enum:
              - price
              - subscription_price
              - cv
              - qv
              - creditable_points
        read_roles:
          type: object
          description: >-
            Price type id => { field => charged | fallback | recurring_pending
            }. A fallback is read only when another figure is blank, zero or
            absent.
          additionalProperties:
            type: object
            additionalProperties:
              type: string
              enum:
                - charged
                - fallback
                - recurring_pending
    ErrorValue:
      description: A validation or API error value.
      anyOf:
        - type: string
        - type: array
          items:
            type: string
        - type: object
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.