> ## Documentation Index
> Fetch the complete documentation index at: https://developers.appstle.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview a product swap with its delivery frequency and recurring price



## OpenAPI

````yaml /subscription/storefront-api-swagger.json post /subscriptions/cp/api/subscription-contract-details/swap-product-frequency/preview
openapi: 3.0.1
info:
  description: >-
    Comprehensive API documentation for the customer-facing subscription portal.
    These APIs enable customers to manage their subscriptions, update billing
    information, modify delivery schedules, and access their account details
    through your storefront.


    **Important**: These APIs must be called from your shop's domain (e.g.,
    https://www.myshop.com/apps/subscriptions/cp/api/**) and require customer
    authentication. Unauthenticated requests will return a 401 Unauthorized
    error.
  title: Storefront APIs
  version: 0.0.1
servers:
  - url: https://www.myshop.com/apps
security: []
tags:
  - description: >-
      Core customer portal APIs for managing customer account settings,
      authentication, and portal configurations.
    name: Customer Portal
  - description: >-
      APIs for customers to view and manage their subscription contracts
      including status updates, frequency changes, and cancellations.
    name: Subscription Management
  - description: >-
      APIs for retrieving and updating subscription contract details — delivery
      schedules, line items, addresses, billing cycles.
    name: Subscription Contracts
  - description: >-
      APIs for retrieving available subscription plans and selling plan
      configurations exposed to customers.
    name: Subscription Plans
  - description: >-
      APIs for managing one-time add-on products that can be purchased alongside
      recurring subscription items.
    name: Subscription One-Time Products
  - description: >-
      APIs for retrieving aggregated subscription data and account-level
      subscription information for the signed-in customer.
    name: Subscription Data
  - description: >-
      APIs for managing customizable product boxes and bundles where customers
      can select multiple items.
    name: Build-a-Box & Bundles
  - description: >-
      APIs for managing payment methods, billing information, and processing
      subscription payments.
    name: Billing & Payments
  - description: >-
      APIs for retrieving product information, selling plans, variant data, and
      subscription-enabled products available to customers.
    name: Product Catalog
  - description: >-
      APIs for managing delivery schedules, shipping addresses, delivery
      methods, and tracking order status.
    name: Delivery & Shipping
  - description: >-
      APIs for handling subscription cancellations, retention activities, and
      customer feedback management.
    name: Customer Retention
  - description: >-
      APIs for integrating loyalty programs with subscriptions including points
      redemption and earning options.
    name: Loyalty Integration
  - description: >-
      APIs for accessing portal customization settings, translations, and theme
      configurations.
    name: Customization
  - description: >-
      APIs for retrieving promotional campaigns shown in the customer portal,
      tracking banner engagement, and redeeming campaign offers.
    name: Campaigns
  - description: >-
      APIs for local pickup and click-and-collect — listing pickup locations and
      resolving eligible pickup dates and time slots.
    name: Store Pickup
paths:
  /subscriptions/cp/api/subscription-contract-details/swap-product-frequency/preview:
    post:
      tags:
        - Subscription Contract Details
      summary: Preview a product swap with its delivery frequency and recurring price
      operationId: preview
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SwapProductFrequencyRequestDTO'
        required: true
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SwapProductFrequencyPreviewDTO'
          description: OK
components:
  schemas:
    SwapProductFrequencyRequestDTO:
      properties:
        contractId:
          format: int64
          type: integer
        expectedRecurringSubtotal:
          type: number
        newVariantId:
          format: int64
          type: integer
        oldLineId:
          type: string
        quantity:
          format: int32
          type: integer
        sellingPlanId:
          type: string
      type: object
    SwapProductFrequencyPreviewDTO:
      properties:
        currencyCode:
          type: string
        currentBillingFrequencyCount:
          format: int32
          type: integer
        currentBillingFrequencyInterval:
          type: string
        currentDeliveryFrequencyCount:
          format: int32
          type: integer
        currentDeliveryFrequencyInterval:
          type: string
        currentFrequencyName:
          type: string
        message:
          type: string
        options:
          items:
            $ref: '#/components/schemas/SwapProductFrequencyOptionDTO'
          type: array
        productTitle:
          type: string
        quantity:
          format: int32
          type: integer
        showFrequencyPicker:
          type: boolean
        status:
          type: string
      type: object
    SwapProductFrequencyOptionDTO:
      properties:
        billingFrequencyCount:
          format: int32
          type: integer
        billingFrequencyInterval:
          type: string
        currentFrequency:
          type: boolean
        deliveryFrequencyCount:
          format: int32
          type: integer
        deliveryFrequencyInterval:
          type: string
        frequencyName:
          type: string
        keepCurrentSchedule:
          type: boolean
        lineSubtotal:
          type: number
        quantity:
          format: int32
          type: integer
        recurringSubtotal:
          type: number
        sellingPlanId:
          type: string
        unitPrice:
          type: number
      type: object

````

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