Remove products or variants from a subscription group

Removes specified products and/or variants from an existing subscription group (selling plan group). This endpoint allows selective removal of products without affecting the group’s configuration or other product assignments.

Full behavior, validation rules, and side effects

Key Features:

• Remove multiple products and variants in a single request
• Remove all products from a specific collection
• Silently ignores products/variants not currently in the group
• Preserves subscription group configuration and settings
• Updates synchronously and returns the modified group

Collection Removal:

• When collectionId is provided, fetches and removes all products from that collection
• Collection processing is limited to 5000 products maximum
• Collection removal is additive to any explicitly specified productIds/variantIds

Important Notes:

• Removing products does NOT affect existing active subscriptions
• Can remove all products, leaving an empty subscription group
• Products/variants not in the group are silently ignored
• Use numeric IDs without gid:// prefix for products and variants

Authentication: Requires valid X-API-Key header

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

Remove products or variants from a subscription group

cURL

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

200

Success Response

{
  "id": 123456789,
  "groupName": "Monthly Coffee Subscription",
  "productCount": 5,
  "productVariantCount": 15,
  "productIds": "[{\"id\":987654322,\"title\":\"Organic Dark Roast\"},{\"id\":987654323,\"title\":\"Colombian Single Origin\"}]",
  "variantIds": "[{\"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
    }
  ]
}

Headers

X-API-Key · string · required

API Key for authentication

Path Parameters

id · integer<int64> · required

Subscription group ID (numeric ID)

Query Parameters

productIds · string

Comma-separated list of product IDs to remove. Use numeric IDs without gid:// prefix.

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

variantIds · string

Comma-separated list of variant IDs to remove. Use numeric IDs without gid:// prefix.

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

collectionId · integer<int64>

Shopify collection ID. When provided, removes all products from this collection (up to 5000 products). This is in addition to any explicitly specified productIds/variantIds.

deleteAllProductsAndVariants · boolean

Set to true to delete all products and their variants. Defaults to false.

api_key · string

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

Response

200

application/json

Products/variants successfully removed from subscription group

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