Update subscription group details and product assignments

Updates an existing subscription group (selling plan group) including its name, selling plans configuration, and optionally manages product/variant assignments. This endpoint provides comprehensive update capabilities for both the subscription group structure and its product associations.

Full behavior, validation rules, and side effects

Key Capabilities:

• Update subscription group name
• Modify existing selling plan configurations (discounts, frequencies, trials, etc.)
• Add or remove products/variants through updateProducts and deleteProducts fields
• Cannot add or remove selling plans - only modify existing ones
• Automatically handles complex discount transitions for free trials and prepaid plans
• Updates delivery profile associations if changed
• Triggers asynchronous operations for metafield updates and free product checks

Important Notes:

• The ‘id’ field is required and must match an existing subscription group
• For each selling plan in subscriptionPlans array, provide ‘idNew’ with the existing selling plan ID
• Plan modifications maintain the same selling plan ID in Shopify
• Product/variant updates are processed after group details are updated
• Large product updates (allProduct=true) run asynchronously

Selling Plan Updates:

• Can change discount amounts, types, and cycles
• Can modify billing/delivery frequencies
• Can add/remove free trials
• Can change member restrictions and tags
• Can update specific day delivery settings
• Can modify min/max cycles

Authentication: Requires valid X-API-Key header

PUT /api/external/v2/subscription-groups

cURL

Update Group Name and Discount

curl --request PUT \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-groups \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "id": 123456789,
  "groupName": "Premium Coffee Club - Updated",
  "subscriptionPlans": [
    {
      "idNew": "gid://shopify/SellingPlan/111111",
      "frequencyName": "Monthly Delivery",
      "frequencyDescription": "Updated description with better savings",
      "frequencyCount": 1,
      "frequencyInterval": "MONTH",
      "planType": "PAY_AS_YOU_GO",
      "discountEnabled": true,
      "discountType": "PERCENTAGE",
      "discountOffer": 15,
      "afterCycle1": 0,
      "minCycles": 3
    }
  ]
}
'

200

Success Response

{
  "id": 123456789,
  "groupName": "Updated Monthly Coffee Subscription",
  "productCount": 8,
  "productVariantCount": 24,
  "productIds": "[{\"id\":987654321,\"title\":\"Premium Coffee Blend\",\"status\":\"ACTIVE\"}]",
  "variantIds": "[{\"id\":123456789,\"title\":\"250g Bag\",\"status\":\"ACTIVE\"}]",
  "subscriptionPlans": [
    {
      "id": "gid://shopify/SellingPlan/111111",
      "idNew": "gid://shopify/SellingPlan/111111",
      "frequencyName": "Updated Monthly Delivery",
      "frequencyDescription": "Fresh coffee delivered monthly with new pricing",
      "frequencyCount": 1,
      "frequencyInterval": "MONTH",
      "billingFrequencyCount": 1,
      "billingFrequencyInterval": "MONTH",
      "discountEnabled": true,
      "discountType": "PERCENTAGE",
      "discountOffer": 15,
      "afterCycle1": 0,
      "discountEnabled2": true,
      "discountType2": "PERCENTAGE",
      "discountOffer2": 20,
      "afterCycle2": 6,
      "planType": "PAY_AS_YOU_GO",
      "minCycles": 3,
      "maxCycles": 24
    }
  ]
}

Headers

X-API-Key · string · required

API Key for authentication

Body

application/json

Complete subscription group update request including group details, selling plans, and optional product management

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

Response

200

application/json

Subscription group successfully updated

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