> ## 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.
> Lists use cursor pagination via the page[cursor] and page[limit] query params; follow meta.pagination.next_cursor until it is null.
> Never use /api/company/v1 or /api/v1 paths, page/per_page params, or offset pagination — they are legacy.
> 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/auth-v0.yaml covers the unversioned auth surface (/api/... paths — authentication, MFA, social auth, and token exchange); 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).
> Successful responses wrap the resource payload alongside a top-level integer status and a meta object.

# Skip the exhausted failed cycle

> Waives the missed billing and shipping cycle without collecting payment and without creating an order or shipment. The missed shipment is skipped. The subscription's original billing and shipping cadence and anchors are preserved, and each stored next date is advanced independently only as needed to reach a future local date.



## OpenAPI

````yaml /api-reference/checkout-v2026-04.yaml post /api/checkout/v2026-04/subscriptions/{token}/failed-cycle-waiver
openapi: 3.1.0
info:
  title: Fluid Checkout API
  description: >-
    **Fluid Checkout API — for building a checkout directly against REST.**


    Use this surface if you are integrating server-to-server or building your
    own

    checkout UI. It covers the full order lifecycle (cart → address → shipping →

    discount → complete → order) plus the logged-in customer's account: saved

    addresses, saved payment methods, order history, loyalty points, and

    subscription management (pause, resume, skip, cancel, retry).


    **The cart token in the URL scopes cart access** — creating a cart, adding

    items, applying a discount, and completing a cart need no bearer token.

    Among the cart operations, a Bearer token is required only for

    `carts/{cart_token}/sync`, `carts/{cart_token}/volume_rep`, and

    `carts/{cart_token}/discount/manual`. Off the cart, a token is required for

    everything under `customers/me` and `subscriptions`, and for the store and

    directory lookups (`store/config`, `store/languages`, `reps`, `users`) and

    `subscription_bundles`. `store/countries` accepts a token but does not

    require one — it returns the same list either way.


    **If you are using the `@fluid-app` FairShare SDK in a theme or storefront,

    you are not calling this surface** — the SDK calls the Fluid Public SDK API

    (`public-v2025-06`). Do not mix the two against one cart: they share the
    same

    cart records and services, but their request shapes differ. See

    [Choosing a cart
    surface](https://docs.fluid.app/api/choosing-a-cart-surface)

    for the operation map and boundary.
  version: v2026-04
  contact:
    email: support@fluid.app
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.fluid.app
security: []
tags:
  - name: carts
    description: >-
      Create, read, and mutate checkout carts (email, address, country,
      language, shipping, recalculation, completion).
  - name: cart-auth
    description: >-
      Cart-scoped customer authentication — magic-link challenge, verification,
      identity, and logout.
  - name: cart-discount
    description: >-
      Apply, list, and remove cart discount codes, including admin manual
      discounts.
  - name: cart-items
    description: Add, update, and remove line items on a cart.
  - name: cart-points
    description: Apply and remove loyalty points on a cart.
  - name: customers
    description: The authenticated customer's profile and company memberships.
  - name: customer-addresses
    description: The authenticated customer's saved shipping/billing addresses.
  - name: customer-orders
    description: The authenticated customer's order history.
  - name: customer-payment-methods
    description: The authenticated customer's saved payment methods and tokenization.
  - name: customer-points
    description: The authenticated customer's loyalty point balances.
  - name: directory
    description: Company rep and user directory lookups.
  - name: enrollments
    description: >-
      Public enrollment forms — retrieve a form and submit, update, or upload
      field answers.
  - name: orders
    description: Public order lookup by token.
  - name: products
    description: Public product queries for the storefront checkout.
  - name: store
    description: >-
      Store-level checkout configuration — countries, languages, address fields,
      agreements, drop zones, and Apple Pay domain verification.
  - name: subscriptions
    description: >-
      Manage subscriptions — pause, resume, skip, cancel, reactivate, retry, and
      failed-cycle waivers.
  - name: subscription-bundles
    description: List and create subscription bundles.
paths:
  /api/checkout/v2026-04/subscriptions/{token}/failed-cycle-waiver:
    post:
      tags:
        - subscriptions
      summary: Skip the exhausted failed cycle
      description: >-
        Waives the missed billing and shipping cycle without collecting payment
        and without creating an order or shipment. The missed shipment is
        skipped. The subscription's original billing and shipping cadence and
        anchors are preserved, and each stored next date is advanced
        independently only as needed to reach a future local date.
      operationId: checkout_v2026_04_failed_cycle_waiver_create
      parameters:
        - name: token
          in: path
          required: true
          description: Subscription token
          schema:
            type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
      responses:
        '200':
          description: Failed cycle waived and future schedule restored
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedCycleWaiverMutationResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '404':
          description: Subscription not found or not owned by the authenticated customer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Subscription state changed or the waiver could not be persisted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearer_auth: []
components:
  schemas:
    FailedCycleWaiverMutationResponse:
      allOf:
        - $ref: '#/components/schemas/SubscriptionResponse'
        - type: object
          required:
            - subscription
            - meta
          properties:
            subscription:
              type: object
              required:
                - status
                - next_bill_date
                - next_ship_date
              properties:
                status:
                  type: string
                  enum:
                    - active
                next_bill_date:
                  type: string
                  format: date-time
                next_ship_date:
                  type: string
                  format: date-time
    UnauthorizedResponse:
      type: object
      properties:
        message:
          type: string
      required:
        - message
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - error_message
        - errors
        - meta
      properties:
        error_message:
          type: string
        errors:
          $ref: '#/components/schemas/ErrorBag'
        meta:
          $ref: '#/components/schemas/CheckoutMeta'
    SubscriptionResponse:
      description: Single subscription with associations
      type: object
      required:
        - subscription
      properties:
        subscription:
          type: object
          additionalProperties: false
          description: Subscription rendered by SubscriptionBlueprinter
          properties:
            subscription_discounts:
              type: array
              description: >-
                Active first-class discount attachments on this subscription.
                Empty array when none.
              items:
                type: object
                properties:
                  id:
                    type: integer
                  duration:
                    type: string
                    enum:
                      - forever
                      - once
                      - repeating
                  duration_cycles:
                    type:
                      - integer
                      - 'null'
                  applied_cycles:
                    type: integer
                  removed_reason:
                    type:
                      - string
                      - 'null'
                  attached_via:
                    type: string
                  discount:
                    type: object
                    additionalProperties: false
                    properties:
                      id:
                        type: integer
                      code:
                        type: string
                  discount_version:
                    type: object
                    additionalProperties: false
                    properties:
                      id:
                        type: integer
                      version_number:
                        type: integer
                      code:
                        type: string
                      price_discount_type:
                        type: string
                      flat_value:
                        type:
                          - number
                          - 'null'
                      percentage_value:
                        type:
                          - number
                          - 'null'
                      apply_to_volume:
                        type: boolean
                  starts_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
                  removed_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
                  attached_by:
                    type:
                      - object
                      - 'null'
                    properties:
                      kind:
                        type: string
                        enum:
                          - member
                          - droplet_installation
                      id:
                        type:
                          - integer
                          - string
                      label:
                        type:
                          - string
                          - 'null'
            renewal_discount_total:
              type: number
              description: >-
                Computed discount applied to the next renewal (includes
                renewal-callback amounts; capped at subscription price).
            id:
              type: integer
            subscription_token:
              type: string
            status:
              type: string
            currency:
              anyOf:
                - type: 'null'
                - $ref: '#/components/schemas/CheckoutSubscriptionCurrency'
            timezone:
              type: string
            address_id:
              type:
                - integer
                - 'null'
            order_id:
              type:
                - integer
                - 'null'
            notes:
              type:
                - string
                - 'null'
            customer_notes:
              type:
                - array
                - 'null'
              items:
                $ref: '#/components/schemas/CheckoutSubscriptionCustomerNote'
            quantity:
              type: integer
            decline_count:
              type: integer
            attempts:
              type: integer
            skipped_count:
              type: integer
            max_skips:
              type:
                - integer
                - 'null'
            digital:
              type: boolean
            disabled:
              type: boolean
            price:
              type: number
            original_price:
              type: number
            cv:
              type: string
              format: decimal
            qv:
              type: string
              format: decimal
            cv_total:
              type: string
              format: decimal
            qv_total:
              type: string
              format: decimal
            shipping_fee:
              type:
                - number
                - string
                - 'null'
            shipping_fee_for_display:
              type:
                - string
                - 'null'
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
            cancelled_at:
              type:
                - string
                - 'null'
              format: date-time
            last_bill_date:
              type:
                - string
                - 'null'
              format: date-time
            next_bill_date:
              type:
                - string
                - 'null'
              format: date-time
            last_ship_date:
              type:
                - string
                - 'null'
              format: date-time
            next_ship_date:
              type:
                - string
                - 'null'
              format: date-time
            last_failed_at:
              type:
                - string
                - 'null'
              format: date-time
            next_retry_at:
              type:
                - string
                - 'null'
              format: date-time
            customer:
              anyOf:
                - type: 'null'
                - $ref: '#/components/schemas/CheckoutSubscriptionCustomer'
            address:
              anyOf:
                - type: 'null'
                - $ref: '#/components/schemas/CheckoutSubscriptionAddress'
            variant:
              anyOf:
                - type: 'null'
                - $ref: '#/components/schemas/CheckoutSubscriptionVariant'
            subscription_plan:
              anyOf:
                - type: 'null'
                - $ref: '#/components/schemas/CheckoutSubscriptionPlanDetail'
            company:
              anyOf:
                - type: 'null'
                - $ref: '#/components/schemas/CheckoutSubscriptionCompany'
            country:
              anyOf:
                - type: 'null'
                - $ref: '#/components/schemas/CheckoutSubscriptionCountry'
            volume_rep:
              type:
                - object
                - 'null'
              additionalProperties: false
              properties:
                id:
                  type:
                    - integer
                    - 'null'
                email:
                  type:
                    - string
                    - 'null'
                full_name:
                  type:
                    - string
                    - 'null'
                image_url:
                  type:
                    - string
                    - 'null'
                external_id:
                  type:
                    - string
                    - 'null'
            next_order:
              type:
                - object
                - 'null'
              additionalProperties: false
              properties:
                bill_date:
                  type:
                    - string
                    - 'null'
                item_quantity:
                  type: string
                item_price:
                  type: string
            payment_method:
              anyOf:
                - type: 'null'
                - $ref: '#/components/schemas/CheckoutSubscriptionPaymentMethodDetail'
            orders:
              type: array
              items:
                $ref: '#/components/schemas/CheckoutSubscriptionOrder'
            bundled_items:
              type: array
              items:
                $ref: '#/components/schemas/CheckoutSubscriptionBundledItem'
            bundled_subscriptions:
              type: array
              items:
                type: object
                additionalProperties: false
                properties:
                  id:
                    type: integer
                  subscription_token:
                    type: string
                  price:
                    type: number
                  original_price:
                    type: number
                  subscription_plan_name:
                    type: string
                  currency:
                    anyOf:
                      - type: 'null'
                      - $ref: '#/components/schemas/CheckoutSubscriptionCurrency'
                  variant:
                    anyOf:
                      - type: 'null'
                      - $ref: '#/components/schemas/CheckoutSubscriptionVariant'
            subscription_skips:
              type: array
              items:
                type: object
                additionalProperties: false
                properties:
                  id:
                    type: integer
                  skipped_date:
                    type: string
                  reason:
                    type:
                      - string
                      - 'null'
                  unskipped_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
        meta:
          $ref: '#/components/schemas/Meta'
    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'
    CheckoutMeta:
      type: object
      additionalProperties: false
      required:
        - request_id
        - timestamp
      properties:
        request_id:
          type:
            - string
            - 'null'
        timestamp:
          type: string
          format: date-time
    CheckoutSubscriptionCurrency:
      description: Currency rendered by CurrencyBlueprinter (default view)
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
        name:
          type:
            - string
            - 'null'
        code:
          type:
            - string
            - 'null'
        rate:
          type:
            - string
            - number
            - 'null'
        active:
          type:
            - boolean
            - 'null'
        symbol:
          type:
            - string
            - 'null'
    CheckoutSubscriptionCustomerNote:
      description: Customer note rendered by CustomerNoteBlueprinter (default view)
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
        note:
          type: string
        customer_id:
          type:
            - integer
            - 'null'
        resource_id:
          type:
            - integer
            - 'null'
        resource_type:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        user_company_id:
          type:
            - integer
            - 'null'
        user_company:
          type:
            - object
            - 'null'
          additionalProperties: false
          properties:
            id:
              type:
                - integer
                - 'null'
            first_name:
              type:
                - string
                - 'null'
            last_name:
              type:
                - string
                - 'null'
            full_name:
              type:
                - string
                - 'null'
            email:
              type:
                - string
                - 'null'
            image_url:
              type:
                - string
                - 'null'
    CheckoutSubscriptionCustomer:
      description: >-
        Customer rendered by CustomerBlueprinter. Covers both the index embed
        (view with_associations) and the detail embed (view extended); the
        extended-only fields (subscription counts, metafields, member_id, jwt)
        are optional.
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
        full_name:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        user_company_id:
          type:
            - integer
            - 'null'
        metadata:
          type: object
          additionalProperties: true
        email_marketing:
          type: boolean
        sms_marketing:
          type: boolean
        account_id:
          type:
            - string
            - 'null'
        phone:
          type:
            - string
            - 'null'
        external_id:
          type:
            - string
            - 'null'
        first_name:
          type:
            - string
            - 'null'
        last_name:
          type:
            - string
            - 'null'
        verified_email:
          type:
            - boolean
            - 'null'
        orders_count:
          type:
            - integer
            - 'null'
        display_total_spent:
          type:
            - string
            - 'null'
        name:
          type: string
        role:
          type: string
        last_order_id:
          type:
            - integer
            - 'null'
        notes:
          type:
            - string
            - 'null'
        active:
          type: boolean
        total_spent:
          type:
            - string
            - number
            - 'null'
        customer_notes:
          type: array
          items:
            $ref: '#/components/schemas/CheckoutSubscriptionCustomerNote'
        default_address:
          anyOf:
            - type: 'null'
            - $ref: '#/components/schemas/CheckoutSubscriptionAddress'
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/CheckoutSubscriptionAddress'
        payment_methods:
          type: array
          items:
            $ref: '#/components/schemas/CheckoutSubscriptionCustomerPaymentMethod'
        is_rep:
          type: boolean
        is_discarded:
          type: boolean
        tax_exempt:
          type: boolean
        sales_tax_id:
          type:
            - string
            - 'null'
        active_subscriptions_count:
          type: integer
        inactive_subscriptions_count:
          type: integer
        metafields:
          type: array
          items:
            $ref: '#/components/schemas/CheckoutSubscriptionMetafield'
        member_id:
          type:
            - string
            - 'null'
        jwt:
          type: string
    CheckoutSubscriptionAddress:
      description: >-
        Address rendered by AddressBlueprinter (default view). Also used for the
        subscription's shipping-address snapshot, whose id may be null.
      type: object
      additionalProperties: false
      properties:
        id:
          type:
            - integer
            - 'null'
        name:
          type:
            - string
            - 'null'
        address1:
          type:
            - string
            - 'null'
        address2:
          type:
            - string
            - 'null'
        address3:
          type:
            - string
            - 'null'
        city:
          type:
            - string
            - 'null'
        state:
          type:
            - string
            - 'null'
        subdivision_code:
          type:
            - string
            - 'null'
        postal_code:
          type:
            - string
            - 'null'
        country_code:
          type:
            - string
            - 'null'
        phone:
          type:
            - string
            - 'null'
        country_num_code:
          type:
            - integer
            - 'null'
        default:
          type:
            - boolean
            - 'null'
    CheckoutSubscriptionVariant:
      description: >-
        Variant rendered by VariantBlueprinter (views with_product /
        with_product_shallow). customer_limit and active_variant_countries only
        appear on the shallow view used inside bundle group items.
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
        title:
          type:
            - string
            - 'null'
        display_name:
          type:
            - string
            - 'null'
        image_url:
          type:
            - string
            - 'null'
        image_path:
          type:
            - string
            - 'null'
        sku:
          type:
            - string
            - 'null'
        primary_image:
          type:
            - string
            - 'null'
        price:
          type:
            - string
            - 'null'
        price_in_currency:
          type:
            - string
            - 'null'
        currency_code:
          type:
            - string
            - 'null'
        options:
          type: array
          items:
            type: object
            additionalProperties: false
            properties:
              title:
                type:
                  - string
                  - 'null'
              value:
                type:
                  - string
                  - 'null'
        customer_limit:
          type:
            - integer
            - 'null'
        active_variant_countries:
          type: array
          items:
            type: string
        product:
          anyOf:
            - type: 'null'
            - $ref: '#/components/schemas/CheckoutSubscriptionProduct'
    CheckoutSubscriptionPlanDetail:
      description: Subscription plan rendered by SubscriptionPlanBlueprinter (default view)
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
        name:
          type: string
        billing_interval:
          type: integer
        billing_interval_unit:
          type: string
        billing_frequency_in_words:
          type:
            - string
            - 'null'
        shipping_interval:
          type: integer
        shipping_interval_unit:
          type: string
        volume_interval:
          type: integer
        volume_interval_unit:
          type: string
        trial_period:
          type:
            - integer
            - 'null'
        trial_period_unit:
          type:
            - string
            - 'null'
        split_volume:
          type: boolean
        allow_skipping:
          type:
            - boolean
            - 'null'
        max_skips:
          type:
            - integer
            - 'null'
        allow_max_billing_cycles:
          type: boolean
        max_billing_cycles:
          type:
            - integer
            - 'null'
        price_adjustment_type:
          type:
            - string
            - 'null'
        price_adjustment_amount:
          type: number
        savings_display_mode:
          type: string
        active:
          type:
            - boolean
            - 'null'
        company_default:
          type:
            - boolean
            - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        products_count:
          type: integer
        subscribers_count:
          type: integer
    CheckoutSubscriptionCompany:
      description: Company rendered by CompanyBlueprint (default view)
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
        name:
          type:
            - string
            - 'null'
    CheckoutSubscriptionCountry:
      description: Country rendered by CountryBlueprinter (default view)
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
        name:
          type:
            - string
            - 'null'
        iso:
          type:
            - string
            - 'null'
    CheckoutSubscriptionPaymentMethodDetail:
      description: >-
        Payment method rendered by PaymentMethodBlueprinter (view fluid_pay).
        The nested details object is a union of the per-source shapes (card,
        PayPal, or empty for other sources).
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
        source:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        payment_title:
          type:
            - string
            - 'null'
        au_status:
          type:
            - string
            - 'null'
        default:
          type: boolean
        payment_type:
          type: string
        details:
          type: object
          additionalProperties: false
          properties:
            id:
              type: integer
            type:
              type: string
              enum:
                - CreditCard
                - PayPal
            card_network:
              type:
                - string
                - 'null'
            card_brand:
              type:
                - string
                - 'null'
            last4_digits:
              type:
                - string
                - 'null'
            last_four:
              type:
                - string
                - 'null'
            exp_month:
              type:
                - string
                - integer
                - 'null'
            exp_year:
              type:
                - string
                - integer
                - 'null'
            logo_url:
              type:
                - string
                - 'null'
            vgs_card_id:
              type:
                - string
                - 'null'
            requires_3ds:
              type: boolean
            vault_id:
              type:
                - string
                - 'null'
            email_address:
              type:
                - string
                - 'null'
            id_token:
              type:
                - string
                - 'null'
        billing_address:
          type:
            - object
            - 'null'
          additionalProperties: false
          properties:
            address1:
              type:
                - string
                - 'null'
            address2:
              type:
                - string
                - 'null'
            city:
              type:
                - string
                - 'null'
            state:
              type:
                - string
                - 'null'
            postal_code:
              type:
                - string
                - 'null'
            zip:
              type:
                - string
                - 'null'
            country_code:
              type:
                - string
                - 'null'
            name:
              type:
                - string
                - 'null'
    CheckoutSubscriptionOrder:
      description: >-
        Order rendered by Commerce::OrderBlueprinter (view
        subscription_interface = default fields + shipping_method +
        items_quantity)
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
        first_name:
          type:
            - string
            - 'null'
        last_name:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        phone:
          type:
            - string
            - 'null'
        order_number:
          type:
            - string
            - 'null'
        status:
          type:
            - string
            - 'null'
        order_type:
          type:
            - string
            - 'null'
        source:
          type:
            - string
            - 'null'
        amount:
          type:
            - string
            - number
            - 'null'
        amount_in_base:
          type:
            - string
            - number
            - 'null'
        base_to_currency_rate:
          type:
            - string
            - number
            - 'null'
        note:
          type:
            - string
            - 'null'
        currency_code:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        metadata:
          type:
            - object
            - 'null'
          additionalProperties: true
        token:
          type:
            - string
            - 'null'
        refundable_amount:
          type:
            - string
            - number
        order_status:
          type: string
        fulfillment_status:
          type: string
        financial_status:
          type: string
        warehouse_id:
          type:
            - integer
            - 'null'
        points_applied:
          type: integer
        points_applied_amount:
          type: number
        points_applied_amount_in_currency:
          type:
            - string
            - 'null'
        order_total_after_points_redemption:
          type: number
        total_points_credited:
          type: integer
        free_shipping:
          type: boolean
        discount_codes:
          type: array
          items:
            type:
              - string
              - 'null'
        created_subscriptions:
          type: array
          items:
            type: string
        shipping_method:
          type: object
          additionalProperties: false
          properties:
            id:
              type:
                - string
                - integer
                - 'null'
            title:
              type:
                - string
                - 'null'
            delivery_time_estimate:
              type:
                - string
                - 'null'
        items_quantity:
          type: integer
    CheckoutSubscriptionBundledItem:
      description: >-
        Bundled item entry stored in the subscription's metadata (written by
        Commerce::Carts::ItemService / BundleGroupPricing)
      type: object
      additionalProperties: false
      properties:
        variant_id:
          type: integer
        product_id:
          type: integer
        product_title:
          type:
            - string
            - 'null'
        variant_title:
          type:
            - string
            - 'null'
        option_titles:
          type: array
          items:
            type:
              - string
              - 'null'
        quantity:
          type: integer
        display_to_customer:
          type: boolean
        price:
          type:
            - string
            - number
            - 'null'
        group_title:
          type:
            - string
            - 'null'
        product_bundle_group_id:
          type:
            - integer
            - 'null'
        subscription:
          type: boolean
        subscription_plan_id:
          type:
            - integer
            - 'null'
    Meta:
      type: object
      properties:
        request_id:
          type:
            - string
            - 'null'
        timestamp:
          type: string
          format: date-time
    ErrorValue:
      description: A validation or API error value.
      anyOf:
        - type: string
        - type: array
          items:
            type: string
        - type: object
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
    CheckoutSubscriptionCustomerPaymentMethod:
      description: >-
        Payment method rendered by PaymentMethodBlueprinter (default view) as
        embedded in customer payloads
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
        source:
          type:
            - string
            - 'null'
        company_id:
          type:
            - integer
            - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        logo_url:
          type:
            - string
            - 'null'
        payment_title:
          type:
            - string
            - 'null'
        user_id:
          type:
            - integer
            - 'null'
    CheckoutSubscriptionMetafield:
      description: Metafield rendered by LegacyMetafieldBlueprint (view with_definition)
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
        namespace:
          type: string
        key:
          type: string
        value:
          $ref: '#/components/schemas/JsonValue'
        value_type:
          type: string
        description:
          type:
            - string
            - 'null'
        owner_type:
          type: string
        owner_id:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        metafield_definition:
          type:
            - object
            - 'null'
          additionalProperties: false
          properties:
            id:
              type: integer
            company_id:
              type: integer
            namespace:
              type: string
            key:
              type: string
            name:
              type:
                - string
                - 'null'
            description:
              type:
                - string
                - 'null'
            value_type:
              type: string
            validation_rules:
              type:
                - object
                - 'null'
              additionalProperties: false
              properties:
                choices:
                  type: array
                  items:
                    $ref: '#/components/schemas/JsonValue'
                min:
                  type:
                    - number
                    - string
                    - 'null'
                max:
                  type:
                    - number
                    - string
                    - 'null'
                max_precision:
                  type:
                    - number
                    - string
                    - 'null'
                regex:
                  type:
                    - string
                    - 'null'
                file_type_options:
                  type: array
                  items:
                    type: string
                list.min:
                  type:
                    - number
                    - string
                    - 'null'
                list.max:
                  type:
                    - number
                    - string
                    - 'null'
                required_keys:
                  type: array
                  items:
                    type: string
                allowed_keys:
                  type: array
                  items:
                    type: string
            owner_resource:
              type: string
            pinned:
              type:
                - boolean
                - 'null'
            position:
              type:
                - integer
                - 'null'
            locked:
              type:
                - boolean
                - 'null'
            created_at:
              type: string
              format: date-time
            updated_at:
              type: string
              format: date-time
            list_type:
              type: boolean
            reference_type:
              type: boolean
            supported_validations:
              type: array
              items:
                type: string
            validation_description:
              type:
                - string
                - 'null'
            category_ids:
              type: array
              items:
                type: integer
    CheckoutSubscriptionProduct:
      description: >-
        Product rendered by ProductBlueprinter (views item /
        item_without_bundle_groups). metafields and product_bundle_groups are
        omitted on the shallow view; product_bundle_groups only renders for
        bundle products.
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
        title:
          type:
            - string
            - 'null'
        image_url:
          type:
            - string
            - 'null'
        image_path:
          type:
            - string
            - 'null'
        cv:
          type:
            - string
            - 'null'
          format: decimal
        tax:
          type:
            - string
            - 'null'
        sku:
          type:
            - string
            - 'null'
        metadata:
          type:
            - object
            - 'null'
          additionalProperties: true
        external_id:
          type:
            - string
            - 'null'
        canonical_url:
          type:
            - string
            - 'null'
        price:
          type:
            - string
            - 'null'
        introduction:
          type:
            - string
            - 'null'
        price_in_currency:
          type:
            - string
            - 'null'
        tax_in_currency:
          type:
            - string
            - 'null'
        cv_in_currency:
          type:
            - string
            - 'null'
        metafields:
          type: array
          items:
            $ref: '#/components/schemas/CheckoutSubscriptionMetafield'
        product_bundle_groups:
          type: array
          items:
            $ref: '#/components/schemas/CheckoutSubscriptionProductBundleGroup'
    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'
    CheckoutSubscriptionProductBundleGroup:
      description: Bundle group rendered by ProductBundleGroupBlueprinter (default view)
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
        title:
          type: string
        description:
          type:
            - string
            - 'null'
        group_type:
          type: string
        purpose:
          type: string
        min_selections:
          type:
            - integer
            - 'null'
        max_selections:
          type:
            - integer
            - 'null'
        selection_type:
          type:
            - string
            - 'null'
        pricing_config:
          type:
            - object
            - 'null'
          additionalProperties: true
          properties:
            pricing_type:
              type: string
            hidden:
              type: boolean
            fixed_price:
              type:
                - string
                - number
                - 'null'
            min_price:
              type:
                - string
                - number
                - 'null'
            country_pricing:
              type: array
              items:
                type: object
                additionalProperties: true
                properties:
                  country_code:
                    type:
                      - string
                      - 'null'
                  enabled:
                    type:
                      - boolean
                      - 'null'
                  price:
                    type:
                      - string
                      - number
                      - 'null'
                  wholesale:
                    type:
                      - string
                      - number
                      - 'null'
                  subscription_price:
                    type:
                      - string
                      - number
                      - 'null'
                  wholesale_subscription_price:
                    type:
                      - string
                      - number
                      - 'null'
                  points:
                    type:
                      - string
                      - number
                      - 'null'
                  cv:
                    type:
                      - number
                      - string
                      - 'null'
                  qv:
                    type:
                      - number
                      - string
                      - 'null'
                  wholesale_cv:
                    type:
                      - number
                      - string
                      - 'null'
                  wholesale_qv:
                    type:
                      - number
                      - string
                      - 'null'
        allow_subscriptions:
          type: boolean
        force_subscriptions:
          type: boolean
        sort_order:
          type: integer
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        images:
          type: array
          items:
            type: object
            additionalProperties: false
            properties:
              id:
                type: integer
              image_url:
                type:
                  - string
                  - 'null'
              image_path:
                type:
                  - string
                  - 'null'
              position:
                type:
                  - integer
                  - 'null'
              dam_asset_code:
                type:
                  - string
                  - 'null'
        bundle_group_items:
          type: array
          items:
            $ref: '#/components/schemas/CheckoutSubscriptionBundleGroupItem'
    CheckoutSubscriptionBundleGroupItem:
      description: Bundle group item rendered by BundleGroupItemBlueprinter (default view)
      type: object
      additionalProperties: false
      properties:
        id:
          type: integer
        quantity:
          type: integer
        sort_order:
          type: integer
        config:
          type: object
          additionalProperties: false
          properties:
            price:
              type:
                - string
                - number
                - 'null'
            pc_price:
              type:
                - string
                - number
                - 'null'
            resolved_price:
              type: string
            resolved_wholesale_price:
              type: string
            resolved_cv:
              type: string
              format: decimal
            resolved_qv:
              type: string
              format: decimal
            resolved_wholesale_cv:
              type: string
              format: decimal
            resolved_wholesale_qv:
              type: string
              format: decimal
            cv:
              type: string
              format: decimal
            qv:
              type: string
              format: decimal
            pc_cv:
              type: string
              format: decimal
            pc_qv:
              type: string
              format: decimal
            is_default:
              type: boolean
            quantity:
              type: integer
            max_quantity:
              type:
                - integer
                - 'null'
            allow_subscription:
              type: boolean
            force_subscription:
              type: boolean
            has_subscription_plans:
              type: boolean
            subscription_plans:
              type: array
              items:
                type: object
                additionalProperties: false
                properties:
                  id:
                    type: integer
                  subscription_price_in_currency:
                    type:
                      - string
                      - 'null'
                  subscribe_and_save_in_currency:
                    type:
                      - string
                      - 'null'
                  subscribe_and_save_for_display:
                    type:
                      - string
                      - 'null'
                  wholesale_subscription_price_in_currency:
                    type:
                      - string
                      - 'null'
                  wholesale_subscribe_and_save_in_currency:
                    type:
                      - string
                      - 'null'
                  wholesale_subscribe_and_save_for_display:
                    type:
                      - string
                      - 'null'
            image_url:
              type:
                - string
                - 'null'
            available_country_codes:
              type: array
              items:
                type: string
            country_prices:
              type: object
              additionalProperties:
                type:
                  - string
                  - number
                  - 'null'
        variant:
          anyOf:
            - type: 'null'
            - $ref: '#/components/schemas/CheckoutSubscriptionVariant'
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      description: Bearer token authentication

````