Get subscription group by ID

Retrieves detailed information about a specific subscription group (selling plan group) by its ID. This endpoint provides complete configuration details for a single subscription group.

Full behavior, validation rules, and side effects

Response includes:

• Group name and configuration
• All selling plans with complete details
• Product and variant assignments
• Discount tiers and configurations
• Free trial settings
• Member restrictions
• Delivery and billing frequencies

Use Cases:

• Display detailed subscription options for editing
• Verify configuration before updates
• Debug subscription issues
• Integration with external systems

Authentication: Requires valid X-API-Key header

GET /api/external/v2/subscription-groups/{id}

Get subscription group by ID

cURL

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

200

{
  "id": 123,
  "productCount": 123,
  "productVariantCount": 123,
  "frequencyCount": 123,
  "frequencyName": "<string>",
  "groupName": "<string>",
  "productIds": "<string>",
  "discountOffer": 123,
  "discountEnabled": true
}

Headers

X-API-Key · string · required

API Key for authentication

Path Parameters

id · integer<int64> · required

Subscription group ID (numeric ID)

Query Parameters

api_key · string

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

Response

200

application/json

Successfully retrieved subscription group

id · integer<int64>

productCount · integer<int64>

productVariantCount · integer<int64>

frequencyCount · integer<int32>

frequencyInterval · enum<string>

Available options: DAY, WEEK, MONTH, YEAR

frequencyName · string

groupName · string

productIds · string

discountOffer · number<double>

discountType · enum<string>

Available options: PERCENTAGE, FIXED, PRICE

discountEnabled · boolean