Get bundle details by handle

Retrieves detailed information about a subscription product bundle including bundled items, pricing, and subscription plan details.

Full behavior, validation rules, and side effects

Key Information Returned:

• Bundle Configuration: Name, handle, description, status
• Bundled Items: Products included in the bundle with quantities
• Pricing: Total price, individual item prices, discounts
• Subscription Details: Associated membership plan, billing frequency
• Product Information: Variant details, images, availability
• Display Settings: How the bundle should be presented to customers

Bundle Components:

• Product handles and variant IDs
• Quantity per product in the bundle
• Bundle-level discounts or pricing rules
• Subscription plan associations
• Custom attributes and metadata

Use Cases:

• Display bundle details on product pages
• Retrieve bundle configuration for cart integration
• Show customers what’s included in a bundle
• Sync bundle data with external systems
• Build custom bundle selection interfaces

Authentication: Requires API key authentication via X-API-Key header or api_key parameter

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

Get bundle details by handle

cURL

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

200

{
  "bundle": {
    "shop": "<string>",
    "id": 123,
    "subscriptionBundlingEnabled": true,
    "subscriptionId": 123,
    "minProductCount": 123,
    "maxProductCount": 123,
    "discount": 123,
    "uniqueRef": "<string>"
  },
  "subscription": {
    "shop": "<string>",
    "id": 123,
    "groupName": "<string>",
    "subscriptionId": 123,
    "productCount": 123,
    "productVariantCount": 123,
    "infoJson": "<string>",
    "productIds": "<string>",
    "variantIds": "<string>",
    "variantProductIds": "<string>",
    "customerTag": "<string>",
    "orderTag": "<string>",
    "rulesJson": "<string>",
    "formFieldsJson": "<string>",
    "savedSearchId": "<string>",
    "savedSegmentSearchId": "<string>",
    "planSequence": 123,
    "memberOrderTag": "<string>",
    "translations": "<string>"
  },
  "products": [
    {
      "shop": "<string>",
      "id": 123,
      "productId": 123,
      "productTitle": "<string>",
      "productHandle": "<string>"
    }
  ],
  "variants": [
    "<string>"
  ]
}

Headers

X-API-Key · string

Path Parameters

handle · string · required

Unique bundle identifier (handle/slug)

Query Parameters

api_key · string

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

Response

200

application/json

Bundle details successfully retrieved

bundle · object

Show child attributes

subscription · object

Show child attributes

products · object[]

Show child attributes

variants · string[]