Subscription Plans

Remove products or variants from ALL subscription groups

Removes specified products and/or variants from ALL subscription groups in the store. This is a powerful bulk operation that affects every subscription group simultaneously.

⚠️ WARNING: This operation:

Affects ALL subscription groups in your store
Cannot be easily undone
Processes synchronously (may timeout for stores with many groups)
Does NOT affect existing active subscriptions

Use Cases:

Discontinuing products from all subscription offerings
Removing seasonal items from all groups
Cleaning up deleted products from subscription groups
Compliance-driven product removals

Important Considerations:

Each group is updated individually
If any group update fails, previous groups remain updated
Large operations may take significant time
Consider using individual group removal for better control

Authentication: Requires valid X-API-Key header

PUT

api

external

subscription-groups

remove-products

Remove products or variants from ALL subscription groups

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

import requests

url = "https://subscription-admin.appstle.com/api/external/v2/subscription-groups/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/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/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/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/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/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

"Product Deleted Successfully"

{
  "detail": "At least one of the Product Id(s) or Variant Id(s) is required",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/bad-request"
}

"<string>"

"<string>"

{
  "detail": "Error processing some subscription groups. Partial updates may have occurred.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://example.com/errors/internal-server-error"
}

Headers

X-API-Key

string

required

API Key for authentication

Query Parameters

productIds

string

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

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

variantIds

string

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

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

api_key

string

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

Response

Products/variants successfully removed from all subscription groups

The response is of type string.

Remove products or variants from ALL subscription groups

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

import requests

url = "https://subscription-admin.appstle.com/api/external/v2/subscription-groups/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/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/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/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/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/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

"Product Deleted Successfully"

{
  "detail": "At least one of the Product Id(s) or Variant Id(s) is required",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/bad-request"
}

"<string>"

"<string>"

{
  "detail": "Error processing some subscription groups. Partial updates may have occurred.",
  "status": 500,
  "title": "Internal Server Error",
  "type": "https://example.com/errors/internal-server-error"
}

Get Started

Guides

Partner Integration

Webhooks

Admin API

Storefront API

Resources

Remove products or variants from ALL subscription groups

Headers

Query Parameters

Response