Add products or variants to an existing subscription group

Adds one or more products and/or product variants to an existing subscription group (selling plan group). This endpoint provides a simple way to expand the product catalog eligible for subscription without modifying the group’s configuration or existing product assignments.

Full behavior, validation rules, and side effects

Key Features:

• Add multiple products and variants in a single request
• Preserves existing product and variant assignments
• Maintains the order of products as provided
• Updates delivery profiles automatically if needed
• Synchronously updates Shopify and returns the updated group
• Optional response enhancement with added products information

Important Notes:

• Product IDs should be numeric Shopify product IDs without the gid:// prefix
• Variant IDs should be numeric Shopify variant IDs without the gid:// prefix
• Adding products also makes all their variants eligible for subscription
• Adding specific variants limits subscription eligibility to those variants only
• Duplicate products/variants are handled gracefully by Shopify
• URL length limits apply to the comma-separated lists (use bulk endpoint for large additions)
• Include ‘x-return-short-response: true’ header to get only added products/variants information in response

Use Cases:

• Launch new products with subscription options
• Add seasonal items to existing subscription groups
• Enable subscription for specific product variants
• Expand subscription eligibility without changing plan configurations
• Track which products were added in the current request

Authentication: Requires valid X-API-Key header

PUT /api/external/v2/subscription-groups/{id}/add-products

Add products or variants to an existing subscription group

cURL

curl --request PUT \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-groups/{id}/add-products \
  --header 'X-API-Key: <x-api-key>'

200

Success Response (Standard)

{
  "id": 123456789,
  "groupName": "Monthly Coffee Subscription",
  "productCount": 10,
  "productVariantCount": 35,
  "productIds": "[{\"id\":987654321,\"title\":\"Premium Coffee Blend\"},{\"id\":987654322,\"title\":\"Organic Dark Roast\"},{\"id\":987654323,\"title\":\"Colombian Single Origin\"}]",
  "variantIds": "[{\"id\":123456789,\"title\":\"250g Bag\"},{\"id\":123456790,\"title\":\"500g Bag\"}]",
  "subscriptionPlans": [
    {
      "id": "gid://shopify/SellingPlan/111111",
      "frequencyName": "Delivered Monthly",
      "frequencyDescription": "Get fresh coffee delivered to your door every month",
      "frequencyCount": 1,
      "frequencyInterval": "MONTH",
      "discountEnabled": true,
      "discountType": "PERCENTAGE",
      "discountOffer": 10,
      "planType": "PAY_AS_YOU_GO"
    }
  ]
}

Headers

X-API-Key · string · required

API Key for authentication

x-return-short-response · boolean · default: false

Header to indicate if response should return only added products ID information. Set to 'true' for minimal response, any other value or omitted for full response.

Path Parameters

id · integer<int64> · required

Subscription group ID (numeric ID)

Query Parameters

api_key · string

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

productIds · string

Comma-separated list of Shopify product IDs to add. Adding a product makes all its variants eligible for subscription. Use numeric IDs only (e.g., '987654321,987654322,987654323')

Pattern: ^\d+(,\d+)*$

variantIds · string

Comma-separated list of Shopify variant IDs to add. Use this to enable subscription for specific variants only. Use numeric IDs only (e.g., '123456789,123456790,123456791')

Pattern: ^\d+(,\d+)*$

Response

200

application/json

Products successfully added to subscription group

Option 1

Option 2

id · integer<int64>

productCount · integer<int64>

productVariantCount · integer<int64>

subscriptionPlans · object[]

Show child attributes

groupName · string

productIds · string

productId · string

variantIds · string

accessoryProductIds · string

updateProducts · object

Show child attributes

deleteProducts · object

Show child attributes

translations · string