Subscription Plans
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.
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 --request PUT \
--url https://subscription-admin.appstle.com/api/external/v2/subscription-groups/{id}/remove-products \
--header 'X-API-Key: <x-api-key>'import requests
url = "https://subscription-admin.appstle.com/api/external/v2/subscription-groups/{id}/remove-products"
headers = {"X-API-Key": "<x-api-key>"}
response = requests.put(url, headers=headers)
print(response.text)const options = {method: 'PUT', headers: {'X-API-Key': '<x-api-key>'}};
fetch('https://subscription-admin.appstle.com/api/external/v2/subscription-groups/{id}/remove-products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://subscription-admin.appstle.com/api/external/v2/subscription-groups/{id}/remove-products';
const options = {method: 'PUT', headers: {'X-API-Key': '<x-api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://subscription-admin.appstle.com/api/external/v2/subscription-groups/{id}/remove-products",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://subscription-admin.appstle.com/api/external/v2/subscription-groups/{id}/remove-products"
req, _ := http.NewRequest("PUT", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://subscription-admin.appstle.com/api/external/v2/subscription-groups/{id}/remove-products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"groupName": "Monthly Coffee Subscription",
"id": 123456789,
"productCount": 5,
"productIds": "[{\"id\":987654322,\"title\":\"Organic Dark Roast\"},{\"id\":987654323,\"title\":\"Colombian Single Origin\"}]",
"productVariantCount": 15,
"subscriptionPlans": [
{
"discountEnabled": true,
"discountOffer": 10,
"discountType": "PERCENTAGE",
"frequencyCount": 1,
"frequencyDescription": "Get fresh coffee delivered to your door every month",
"frequencyInterval": "MONTH",
"frequencyName": "Delivered Monthly",
"id": "gid://shopify/SellingPlan/111111"
}
],
"variantIds": "[{\"id\":123456790,\"title\":\"500g Bag\"}]"
}Headers
API Key for authentication
Path Parameters
Subscription group ID (numeric ID)
Query Parameters
Comma-separated list of product IDs to remove. Use numeric IDs without gid:// prefix.
Pattern:
^\d+(,\d+)*$Comma-separated list of variant IDs to remove. Use numeric IDs without gid:// prefix.
Pattern:
^\d+(,\d+)*$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.
Set to true to delete all products and their variants. Defaults to false.
API Key (Deprecated - Use X-API-Key header instead)
Response
Products/variants successfully removed from subscription group
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Remove products or variants from a subscription group
curl --request PUT \
--url https://subscription-admin.appstle.com/api/external/v2/subscription-groups/{id}/remove-products \
--header 'X-API-Key: <x-api-key>'import requests
url = "https://subscription-admin.appstle.com/api/external/v2/subscription-groups/{id}/remove-products"
headers = {"X-API-Key": "<x-api-key>"}
response = requests.put(url, headers=headers)
print(response.text)const options = {method: 'PUT', headers: {'X-API-Key': '<x-api-key>'}};
fetch('https://subscription-admin.appstle.com/api/external/v2/subscription-groups/{id}/remove-products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://subscription-admin.appstle.com/api/external/v2/subscription-groups/{id}/remove-products';
const options = {method: 'PUT', headers: {'X-API-Key': '<x-api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://subscription-admin.appstle.com/api/external/v2/subscription-groups/{id}/remove-products",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://subscription-admin.appstle.com/api/external/v2/subscription-groups/{id}/remove-products"
req, _ := http.NewRequest("PUT", url, nil)
req.Header.Add("X-API-Key", "<x-api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://subscription-admin.appstle.com/api/external/v2/subscription-groups/{id}/remove-products")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<x-api-key>'
response = http.request(request)
puts response.read_body{
"groupName": "Monthly Coffee Subscription",
"id": 123456789,
"productCount": 5,
"productIds": "[{\"id\":987654322,\"title\":\"Organic Dark Roast\"},{\"id\":987654323,\"title\":\"Colombian Single Origin\"}]",
"productVariantCount": 15,
"subscriptionPlans": [
{
"discountEnabled": true,
"discountOffer": 10,
"discountType": "PERCENTAGE",
"frequencyCount": 1,
"frequencyDescription": "Get fresh coffee delivered to your door every month",
"frequencyInterval": "MONTH",
"frequencyName": "Delivered Monthly",
"id": "gid://shopify/SellingPlan/111111"
}
],
"variantIds": "[{\"id\":123456790,\"title\":\"500g Bag\"}]"
}