Get all subscription groups

Retrieves a list of all subscription groups (selling plan groups) configured in the store. This endpoint provides a complete overview of all subscription offerings available.

Full behavior, validation rules, and side effects

Response includes:

• All subscription groups with their configurations
• Complete selling plan details for each group
• Product and variant assignments (as JSON strings)
• Discount configurations and tiers
• Member restrictions and settings

Use Cases:

• Display all subscription options in a custom interface
• Audit subscription configurations
• Export subscription data for analysis
• Synchronize with external systems

Performance Notes:

• Returns all groups in a single response (no pagination)
• Response size grows with number of groups and plans
• Product/variant lists are JSON-encoded strings within the response

Authentication: Requires valid X-API-Key header

GET /api/external/v2/subscription-groups

Get all subscription groups

cURL

curl --request GET \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-groups \
  --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

Query Parameters

api_key · string

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

Response

200

application/json

Successfully retrieved subscription groups

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