Skip to main content
PUT
/
api
/
external
/
v2
/
subscription-groups
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
    }
  ]
}
'
{
  "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
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://appstleinc-aeca3e0a.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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[]
groupName
string
productIds
string
productId
string
variantIds
string
accessoryProductIds
string
updateProducts
object
deleteProducts
object
translations
string

Response

Subscription group successfully updated

id
integer<int64>
productCount
integer<int64>
productVariantCount
integer<int64>
subscriptionPlans
object[]
groupName
string
productIds
string
productId
string
variantIds
string
accessoryProductIds
string
updateProducts
object
deleteProducts
object
translations
string