Skip to content
External APIs
/
/
Get subscription group by...

External APIs (0.0.1)

Comprehensive API documentation for managing subscriptions, payments, and related operations. These APIs allow you to programmatically manage subscription lifecycles, handle payments, configure products, and integrate subscription functionality into your applications.

Download OpenAPI description
external-api-swagger.json
external-api-swagger.yaml
Languages
Servers
https://subscription-admin.appstle.com

Subscription Management

Core APIs for managing the complete subscription lifecycle including creation, updates, pausing, resuming, and cancellation of subscriptions.

Operations

Subscription Payments

APIs for managing subscription payment methods, processing payments, handling payment retries, and updating billing information.

Operations

Subscription Contracts

APIs for managing subscription contracts including delivery schedules, pricing, order notes, billing cycles, and shipping addresses.

Operations

Subscription Products

APIs for managing products within subscriptions including adding, removing, updating quantities, and swapping products.

Operations

Billing & Payments

APIs for handling billing operations, payment processing, and financial transactions related to subscriptions.

Operations

Subscription Discounts

APIs for managing discounts and promotional codes applied to subscriptions.

Operations

Subscription One-Time Products

APIs for managing one-time add-on products that can be purchased alongside recurring subscription items.

Operations

Subscription Plans

APIs for managing subscription plans, pricing tiers, and plan configurations.

Operations

Bulk add products or variants to an existing subscription group

Request

Adds multiple products and/or product variants to an existing subscription group (selling plan group) using a JSON request body. This endpoint is ideal for adding large numbers of products/variants that would exceed URL length limits in the query parameter version.

Advantages over query parameter endpoint:

  • No URL length restrictions
  • Cleaner syntax for large lists
  • Better for programmatic integrations
  • Supports the same functionality with improved scalability

Behavior:

  • Identical to the query parameter endpoint in functionality
  • Adds products/variants to existing assignments
  • Preserves product order
  • Updates synchronously and returns the updated group

Authentication: Requires valid X-API-Key header

Path
idinteger(int64)required

Subscription group ID (numeric ID)

Example: 123456789
Query
api_keystringDeprecated

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

Headers
X-API-Keystringrequired

API Key for authentication

Example: sk_live_1234567890abcdef
Bodyapplication/jsonrequired

Product and variant IDs to add to the subscription group

productIdsArray of integers(int64)
variantIdsArray of integers(int64)
curl -i -X POST \
  'https://subscription-admin.appstle.com/api/external/v2/subscription-groups/123456789/bulk-add-products?api_key=string' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: sk_live_1234567890abcdef' \
  -d '{
    "productIds": [
      987654321,
      987654322,
      987654323,
      987654324,
      987654325
    ],
    "variantIds": []
  }'

Responses

Products/variants successfully added

Body*/*
object

Get subscription group by ID

Request

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.

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

Path
idinteger(int64)required

Subscription group ID (numeric ID)

Example: 123456789
Query
api_keystringDeprecated

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

Headers
X-API-Keystringrequired

API Key for authentication

Example: sk_live_1234567890abcdef
curl -i -X GET \
  'https://subscription-admin.appstle.com/api/external/v2/subscription-groups/123456789?api_key=string' \
  -H 'X-API-Key: sk_live_1234567890abcdef'

Responses

Successfully retrieved subscription group

Bodyapplication/json
idinteger(int64)
productCountinteger(int64)
productVariantCountinteger(int64)
subscriptionPlansArray of objects(FrequencyInfoDTO)
groupNamestring
productIdsstring
productIdstring
variantIdsstring
accessoryProductIdsstring
updateProductsobject(ProductVariantDTO)
deleteProductsobject(ProductVariantDTO)
translationsstring
Response
application/json
{
  "id": 123456789,
  "groupName": "Monthly Coffee Subscription",
  "productCount": 10,
  "productVariantCount": 35,
  "productIds": "[{\"id\":987654321,\"title\":\"Premium Coffee Blend\",\"status\":\"ACTIVE\",\"handle\":\"premium-coffee-blend\",\"imageSrc\":\"https://cdn.shopify.com/...\",\"vendor\":\"Coffee Co\",\"tags\":\"coffee,subscription\",\"productType\":\"Coffee\",\"price\":\"19.99\"}]",
  "variantIds": "[{\"id\":123456789,\"title\":\"250g Bag\",\"status\":\"ACTIVE\"}]",
  "subscriptionPlans": [
    { … }
  ]
}

Get all selling plans across all subscription groups

Request

Retrieves a flattened list of all selling plans from all subscription groups in the store. This endpoint provides a consolidated view of every subscription plan available, regardless of which group it belongs to.

Response includes:

  • All selling plans with their configurations
  • Group information for each plan (groupId and groupName)
  • Complete discount and pricing details
  • Delivery and billing frequencies
  • Member restrictions and settings
  • Free trial configurations

Use Cases:

  • Build a unified subscription selector
  • Compare all available subscription options
  • Analyze pricing across all plans
  • Find specific plan configurations
  • Generate reports on subscription offerings

Differences from /subscription-groups endpoint:

  • Returns plans as a flat list, not grouped
  • Each plan includes its parent group information
  • Easier to search/filter across all plans
  • Does not include product/variant assignments

Authentication: Requires valid X-API-Key header

Query
api_keystringDeprecated

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

Headers
X-API-Keystringrequired

API Key for authentication

Example: sk_live_1234567890abcdef
curl -i -X GET \
  'https://subscription-admin.appstle.com/api/external/v2/subscription-groups/all-selling-plans?api_key=string' \
  -H 'X-API-Key: sk_live_1234567890abcdef'

Responses

Successfully retrieved all selling plans

Bodyapplication/json
frequencyCountinteger(int32)
frequencyIntervalstring
Enum"DAY""WEEK""MONTH""YEAR"
billingFrequencyCountinteger(int32)
payAsYouGoPrepaidBillingFrequencyCountinteger(int32)
billingFrequencyIntervalstring
Enum"DAY""WEEK""MONTH""YEAR"
frequencyNamestring
frequencyDescriptionstring
discountOffernumber(double)
discountOffer2number(double)
afterCycle1integer(int32)
afterCycle2integer(int32)
discountTypestring
Enum"PERCENTAGE""FIXED""PRICE"
discountType2string
Enum"PERCENTAGE""FIXED""PRICE"
discountEnabledboolean
discountEnabled2boolean
discountEnabledMaskedboolean
discountEnabled2Maskedboolean
idstring
frequencyTypestring
Enum"ON_PURCHASE_DAY""ON_SPECIFIC_DAY"
specificDayValueinteger(int32)
specificMonthValueinteger(int32)
specificDayEnabledboolean
maxCyclesinteger(int32)
minCyclesinteger(int32)
cutOffinteger(int32)
prepaidFlagstring
idNewstring
planTypestring
Enum"PAY_AS_YOU_GO""PREPAID""ADVANCED_PREPAID""PAY_AS_YOU_GO_PREPAID"
deliveryPolicyPreAnchorBehaviorstring
Enum"ASAP""NEXT""$UNKNOWN"
freeTrialEnabledboolean
freeTrialCountinteger(int32)
freeTrialIntervalstring
Enum"DAY""WEEK""MONTH""YEAR"
memberOnlyboolean
nonMemberOnlyboolean
memberInclusiveTagsstring
memberExclusiveTagsstring
formFieldJsonstring
upcomingOrderEmailBufferinteger(int32)
frequencySequenceinteger(int32)
groupNamestring
groupIdinteger(int64)
repeatingCycleboolean
repeatingNumberOfCycleinteger(int32)
keepOriginalNextBillingDateAfterTrialboolean
defaultSelectedPlanboolean
inventoryPolicyReservestring
Enum"ON_FULFILLMENT""ON_SALE""$UNKNOWN"
appstleCyclesArray of objects(AppstleCycle)
Response
application/json
[
  {
    "id": "gid://shopify/SellingPlan/111111",
    "frequencyName": "Delivered Monthly",
    "frequencyDescription": "Save 10% on monthly deliveries",
    "frequencyCount": 1,
    "frequencyInterval": "MONTH",
    "billingFrequencyCount": 1,
    "billingFrequencyInterval": "MONTH",
    "planType": "PAY_AS_YOU_GO",
    "discountEnabled": true,
    "discountType": "PERCENTAGE",
    "discountOffer": 10,
    "afterCycle1": 0,
    "minCycles": 3,
    "maxCycles": null,
    "groupId": 123456789,
    "groupName": "Monthly Coffee Subscription",
    "inventoryPolicyReserve": "ON_SALE",
    "memberOnly": false,
    "frequencyType": "ON_PURCHASE_DAY",
    "upcomingOrderEmailBuffer": 3
  },
  {
    "id": "gid://shopify/SellingPlan/222222",
    "frequencyName": "Weekly Tea Box",
    "frequencyDescription": "Fresh tea every week with 15% savings",
    "frequencyCount": 1,
    "frequencyInterval": "WEEK",
    "billingFrequencyCount": 1,
    "billingFrequencyInterval": "WEEK",
    "planType": "PAY_AS_YOU_GO",
    "discountEnabled": true,
    "discountType": "PERCENTAGE",
    "discountOffer": 15,
    "afterCycle1": 0,
    "groupId": 123456790,
    "groupName": "Premium Tea Collection"
  },
  {
    "id": "gid://shopify/SellingPlan/333333",
    "frequencyName": "3-Month Prepaid Coffee",
    "frequencyDescription": "Pay upfront for 3 months and save 25%",
    "frequencyCount": 1,
    "frequencyInterval": "MONTH",
    "billingFrequencyCount": 3,
    "billingFrequencyInterval": "MONTH",
    "planType": "PAY_AS_YOU_GO_PREPAID",
    "payAsYouGoPrepaidBillingFrequencyCount": 3,
    "discountEnabled": true,
    "discountType": "PERCENTAGE",
    "discountOffer": 25,
    "afterCycle1": 0,
    "maxCycles": 12,
    "groupId": 123456789,
    "groupName": "Monthly Coffee Subscription",
    "repeatingCycle": true,
    "repeatingNumberOfCycle": 12
  }
]

Build-a-Box & Bundles

APIs for managing customizable product boxes and bundles where customers can select multiple items.

Operations

Product Catalog

APIs for managing the product catalog including product information, variants, and inventory.

Operations

Operations & Settings

APIs for managing operational settings, configurations, and administrative functions.

Operations

Customer Portal

APIs powering the customer-facing portal where subscribers can manage their own subscriptions.

Operations

Customers

APIs for managing customer information, profiles, and account details.

Operations