Skip to content
🔧 Admin APIs
/
/
Generate bundle-specific...

External (0.0.1)

Download OpenAPI description
admin-api-swagger.json
admin-api-swagger.yaml
Languages
Servers
https://membership-admin.appstle.com

Shipping & Delivery Profiles

APIs for managing Shopify delivery profiles, shipping rates, zones, and free shipping configuration for subscription memberships

Operations

Customer Discount History

APIs for retrieving historical discount code usage and redemption information for membership contracts

Operations

Cancellation Flow Configuration

APIs for managing membership cancellation flow settings including retention offers, survey questions, and cancel confirmation screens

Operations

Billing & Orders

APIs for managing membership billing attempts, recurring orders, payment retries, order history, and order skipping

Operations

One-Time Add-Ons

APIs for managing one-time product additions to upcoming subscription orders, including adding, retrieving, and removing one-off items

Operations

Membership Plans

APIs for managing membership/subscription plan groups, including creating plans, configuring discounts, billing intervals, and assigning products to plans

Operations

Product Bundles

APIs for managing subscription product bundles, bundle configurations, item grouping, and bundle-specific discount codes

Operations

Generate bundle-specific discount code

Request

Creates a Shopify discount code specifically for a subscription bundle. This endpoint generates unique, single-use or multi-use discount codes tied to bundle purchases.

Key Features:

  • Bundle-Specific Codes: Discounts that apply only to specific bundles
  • Flexible Discount Types: Percentage off, fixed amount off, or free shipping
  • Usage Limits: Single-use, limited use, or unlimited codes
  • Expiration Dates: Set validity periods for promotional campaigns
  • Minimum Requirements: Minimum purchase amount or quantity thresholds
  • Customer Eligibility: Restrict to specific customer segments or tags

Discount Configuration:

  • Code Format: Custom code or auto-generated random code
  • Discount Value: Percentage (e.g., 15%) or fixed amount (e.g., $10)
  • Start/End Dates: Campaign duration controls
  • Usage Limit: Max number of times code can be used
  • Once Per Customer: Prevent code reuse by same customer
  • Bundle Association: Links discount to specific bundle token

Use Cases:

  • Create promotional codes for bundle launches
  • Generate unique codes for influencer campaigns
  • Offer first-time subscriber discounts on bundles
  • Seasonal or holiday bundle promotions
  • Referral program discount codes
  • Partner/affiliate exclusive bundle offers

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

Path
tokenstringrequired

Bundle token identifier

Example: abc123xyz
Query
api_keystring

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

Headers
X-API-Keystring
Bodyapplication/jsonrequired

Discount code configuration including code, value, type, and validity

cartobject(Cart)
curl -i -X PUT \
  'https://membership-admin.appstle.com/api/external/v2/subscription-bundlings/discount/abc123xyz?api_key=string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: string' \
  -d '{
    "cart": {
      "token": "string",
      "note": {},
      "attributes": {},
      "original_total_price": 0,
      "total_price": 0,
      "total_discount": 0,
      "total_weight": 0,
      "item_count": 0,
      "items": [
        {
          "id": 0,
          "properties": {},
          "quantity": 0,
          "variant_id": 0,
          "key": "string",
          "title": "string",
          "price": 0,
          "original_price": 0,
          "discounted_price": 0,
          "line_price": 0,
          "original_line_price": 0,
          "total_discount": 0,
          "discounts": [
            {}
          ],
          "sku": "string",
          "grams": 0,
          "vendor": "string",
          "taxable": true,
          "product_id": 0,
          "product_has_only_default_variant": true,
          "gift_card": true,
          "final_price": 0,
          "final_line_price": 0,
          "url": "string",
          "featured_image": {
            "aspect_ratio": 0,
            "alt": "string",
            "height": 0,
            "url": "string",
            "width": 0
          },
          "image": "string",
          "handle": "string",
          "requires_shipping": true,
          "product_type": "string",
          "product_title": "string",
          "product_description": "string",
          "variant_title": {},
          "variant_options": [
            "string"
          ],
          "options_with_values": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "line_level_discount_allocations": [
            {}
          ],
          "line_level_total_discount": 0
        }
      ],
      "requires_shipping": true,
      "currency": "string",
      "items_subtotal_price": 0,
      "cart_level_discount_applications": [
        {}
      ]
    }
  }'

Responses

Discount code successfully created in Shopify

Bodyapplication/json
discountCodestring
errorMessagestring
discountNeededboolean
Response
application/json
{
  "discountCode": "string",
  "errorMessage": "string",
  "discountNeeded": true
}

Get bundle details by handle

Request

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

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

Path
handlestringrequired

Unique bundle identifier (handle/slug)

Example: coffee-bundle-monthly
Query
api_keystring

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

Headers
X-API-Keystring
curl -i -X GET \
  'https://membership-admin.appstle.com/api/external/v2/subscription-bundlings/external/get-bundle/coffee-bundle-monthly?api_key=string' \
  -H 'X-API-Key: string'

Responses

Bundle details successfully retrieved

Bodyapplication/json
bundleobject(SubscriptionBundling)
subscriptionobject(SubscriptionGroupPlan)
productsArray of objects(ProductInfo)
variantsArray of strings
Response
application/json
{
  "bundle": {
    "id": 0,
    "shop": "string",
    "subscriptionBundlingEnabled": true,
    "subscriptionId": 0,
    "minProductCount": 0,
    "maxProductCount": 0,
    "discount": 0.1,
    "uniqueRef": "string"
  },
  "subscription": {
    "id": 0,
    "shop": "string",
    "groupName": "string",
    "subscriptionId": 0,
    "productCount": 0,
    "productVariantCount": 0,
    "infoJson": "string",
    "productIds": "string",
    "variantIds": "string",
    "variantProductIds": "string",
    "customerTag": "string",
    "orderTag": "string",
    "rulesJson": "string",
    "formFieldsJson": "string",
    "savedSearchId": "string",
    "savedSegmentSearchId": "string",
    "planSequence": 0,
    "memberOrderTag": "string"
  },
  "products": [
    { … }
  ],
  "variants": [
    "string"
  ]
}

Custom CSS Styling

APIs for retrieving custom CSS styles applied to subscription widgets and customer portal for theme customization

Operations

Customer Portal Configuration

APIs for managing customer portal settings including UI customization, text labels, feature toggles, and branding options for the member self-service portal

Operations

Membership Contracts

APIs for managing membership/subscription contracts including creation, updates, status changes, line items, discounts, and billing operations

Operations

Bundle Settings

APIs for managing subscription bundle configuration settings including bundle behavior, pricing rules, and display options

Operations

Customer Payment Methods

APIs for managing customer payment methods, payment tokens, and payment method retrieval for subscriptions

Operations

Product Swap Rules

APIs for retrieving product swap/substitution options allowing members to exchange subscription items based on configured swap rules and variant groups

Operations

Subscription Contract Management

Operations

Subscription Billing

Operations

Billing Attempts

Operations