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

# Get subscription bundle settings by ID



## OpenAPI

````yaml /subscription/storefront-api-swagger.json get /subscriptions/cp/api/subscription-bundle-settings/{id}
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-bundle-settings/{id}:
    get:
      tags:
        - Build-a-Box & Bundles
      summary: Get subscription bundle settings by ID
      operationId: getSubscriptionBundleSettings
      parameters:
        - in: path
          name: id
          required: true
          schema:
            format: int64
            type: integer
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SubscriptionBundleSettingsDTO'
          description: OK
components:
  schemas:
    SubscriptionBundleSettingsDTO:
      properties:
        addButtonText:
          type: string
        additionalProperty:
          additionalProperties:
            type: object
          type: object
          writeOnly: true
        allowAddUnavailableProduct:
          type: boolean
        backgroundColor:
          type: string
        bundleBottomHtml:
          type: string
        bundleRedirect:
          enum:
            - CART
            - CHECKOUT
            - CUSTOM
          type: string
        bundleTopHtml:
          type: string
        buttonBackgroundColor:
          type: string
        buttonColor:
          type: string
        buyQuantityGetDiscount:
          type: string
        cart:
          type: string
        checkoutMessage:
          type: string
        congratsMessageText:
          type: string
        continueShopping:
          type: string
        currencySwitcherClassName:
          type: string
        customRedirectURL:
          type: string
        descriptionLength:
          format: int32
          type: integer
        disableInventoryCheck:
          type: boolean
        disableProductCardImageSlider:
          type: boolean
        disableProductDescription:
          type: boolean
        displayUnavailableProduct:
          type: boolean
        editQuantity:
          type: string
        enableClearCartSelectedProducts:
          type: boolean
        enableCustomAdvancedFields:
          type: boolean
        enableDisplayProductType:
          type: boolean
        enableDisplayProductVendor:
          type: boolean
        enableEditQuantityTextbox:
          type: boolean
        enableOpeningSidebar:
          type: boolean
        enableProductDetailButton:
          type: boolean
        enableRedirectToProductPage:
          type: boolean
        enableShowProductBasePrice:
          type: boolean
        enableSkieyBABHeader:
          type: boolean
        failedToAddMsgText:
          type: string
        failedToAddTitleText:
          type: string
        hideProductSearchBox:
          type: boolean
        id:
          format: int64
          type: integer
        isBundleWithoutScroll:
          type: boolean
        isMergeIntoSingleBABVariantDropdown:
          type: boolean
        itemsText:
          type: string
        leftSidebarHTML:
          type: string
        moveOneTimePurchaseToTop:
          type: boolean
        myDeliveryText:
          type: string
        okBtnText:
          type: string
        openingSidebarType:
          enum:
            - DEFAULT
            - MAX_QUANTITY
            - STOP_AUTO_OPEN
            - MIN_AMOUNT
          type: string
        pageBackgroundColor:
          type: string
        proceedToCheckoutButtonText:
          type: string
        productDetails:
          type: string
        productFilterConfig:
          type: string
        productPriceFormatField:
          type: string
        productTitleFontColor:
          type: string
        productsToProceedText:
          type: string
        quantityLabel:
          type: string
        removeItem:
          type: string
        restrictPriceRateCalculation:
          type: boolean
        rightSidebarHTML:
          type: string
        selectMinimumProductButtonText:
          type: string
        selectedFrequencyLabelText:
          type: string
        shop:
          type: string
        shopCustomizationData:
          items:
            $ref: '#/components/schemas/UpdateShopCustomizationRequest'
          type: array
        shoppingCart:
          type: string
        showCompareAtPrice:
          type: boolean
        showOrderNoteField:
          type: boolean
        showSubLoyaltyTable:
          type: boolean
        skipFilterVariantsByAllocationsId:
          type: boolean
        skipFirstPage:
          type: boolean
        spendAmountGetDiscount:
          type: string
        spentText:
          type: string
        subtotal:
          type: string
        tieredDiscount:
          type: string
        title:
          type: string
        variantLabelTextV2:
          type: string
        variantNotAvailable:
          type: string
        viewProduct:
          type: string
      required:
        - addButtonText
        - myDeliveryText
        - proceedToCheckoutButtonText
        - productsToProceedText
        - selectMinimumProductButtonText
        - selectedFrequencyLabelText
        - shop
      type: object
    UpdateShopCustomizationRequest:
      properties:
        id:
          format: int64
          type: integer
        labelId:
          format: int64
          type: integer
        value:
          type: string
      type: object

````