Generate discount code for bundle

Generates a discount code for a subscription bundle. This endpoint creates a Shopify discount code that can be applied to bundle subscriptions, typically used during the checkout process.

Full behavior, validation rules, and side effects

Discount Code Generation:

• Creates a unique discount code in Shopify
• Associates the discount with the bundle
• Configures discount rules and limitations
• Sets expiration dates if specified
• Applies usage limits if configured

Discount Configuration Options:

• Discount type (percentage, fixed amount, or free shipping)
• Discount value/amount
• Minimum purchase requirements
• Maximum usage count
• Expiration date
• Customer eligibility rules

Use Cases:

• Promotional campaigns for bundles
• Welcome discounts for new subscribers
• Loyalty rewards for existing customers
• Special offers and limited-time promotions
• Partner/affiliate discount codes

Important Notes:

• Discount codes are created in Shopify and follow Shopify’s discount rules
• Codes can be single-use or multi-use depending on configuration
• Expired or depleted codes cannot be reused

Authentication: Requires valid X-API-Key header

PUT /api/external/v2/subscription-bundlings/discount/{token}

Generate discount code for bundle

cURL

curl --request PUT \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-bundlings/discount/{token} \
  --header 'Content-Type: application/json' \
  --data '
{
  "cart": {
    "token": "<string>",
    "note": {},
    "attributes": {},
    "original_total_price": 123,
    "total_price": 123,
    "total_discount": 123,
    "total_weight": 123,
    "item_count": 123,
    "items": [
      {
        "id": 123,
        "properties": {},
        "quantity": 123,
        "variant_id": 123,
        "key": "<string>",
        "title": "<string>",
        "price": 123,
        "original_price": 123,
        "discounted_price": 123,
        "line_price": 123,
        "original_line_price": 123,
        "total_discount": 123,
        "discounts": [
          {}
        ],
        "sku": "<string>",
        "grams": 123,
        "vendor": "<string>",
        "taxable": true,
        "product_id": 123,
        "product_has_only_default_variant": true,
        "gift_card": true,
        "final_price": 123,
        "final_line_price": 123,
        "url": "<string>",
        "featured_image": {
          "aspect_ratio": 123,
          "alt": "<string>",
          "height": 123,
          "url": "<string>",
          "width": 123
        },
        "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": 123
      }
    ],
    "requires_shipping": true,
    "currency": "<string>",
    "items_subtotal_price": 123,
    "cart_level_discount_applications": [
      {}
    ]
  }
}
'

200

Success Response

{
  "discountCode": "BUNDLE10",
  "discountId": "gid://shopify/DiscountCodeNode/123456",
  "discountType": "PERCENTAGE",
  "discountValue": 10,
  "expiresAt": "2024-12-31T23:59:59Z",
  "usageLimit": 100,
  "currentUsageCount": 0,
  "active": true
}

Headers

X-API-Key · string

Path Parameters

token · string · required

Token

Query Parameters

api_key · string

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

Body

application/json

Discount Code Request

cart · object

Show child attributes

Response

200

application/json

Discount code successfully generated