Get bundle details by handle

Retrieves complete details for a subscription bundle using its unique handle. This endpoint returns the bundle configuration, included products, pricing, and available subscription options.

Full behavior, validation rules, and side effects

Bundle Information Returned:

• Bundle name and description
• Product selections with quantities
• Pricing and discounts
• Available subscription frequencies
• Bundle status and availability
• Product images and details

Use Cases:

• Display bundle details on product pages
• Show bundle contents in customer portal
• Fetch bundle configuration for cart/checkout
• Integration with external systems
• Build custom bundle selection interfaces

Bundle Handle: The handle is a unique, URL-friendly identifier for the bundle. It’s typically generated when the bundle is created and remains constant throughout the bundle’s lifecycle.

Authentication: Requires valid X-API-Key header

GET /api/external/v2/subscription-bundlings/external/get-bundle/{handle}

Get bundle details by handle

cURL

curl --request GET \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-bundlings/external/get-bundle/{handle}

200

{
  "bundle": {
    "id": 12345,
    "name": "Premium Coffee Bundle",
    "handle": "premium-coffee-bundle",
    "description": "Choose your favorite coffee blends",
    "minProducts": 2,
    "maxProducts": 5,
    "totalPrice": "49.99",
    "currencyCode": "USD"
  },
  "subscriptions": [
    {
      "frequency": "MONTH",
      "frequencyCount": 1,
      "frequencyName": "Monthly Delivery",
      "discount": 10,
      "discountType": "PERCENTAGE"
    },
    {
      "frequency": "WEEK",
      "frequencyCount": 2,
      "frequencyName": "Bi-Weekly Delivery",
      "discount": 15,
      "discountType": "PERCENTAGE"
    }
  ],
  "products": [
    {
      "variantId": 11111,
      "productId": 99999,
      "title": "Medium Roast Coffee",
      "price": "14.99",
      "image": "https://cdn.shopify.com/image.jpg",
      "available": true
    }
  ]
}

Headers

X-API-Key · string

Path Parameters

handle · string · required

Customer Handle

Query Parameters

api_key · string

API Key (Deprecated - Use Header X-API-Key instead)

Response

200

application/json

Bundle details successfully retrieved