Skip to main content
GET
/
api
/
external
/
v2
/
subscription-groups
/
all-selling-plans
Get all selling plans across all subscription groups
curl --request GET \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-groups/all-selling-plans \
  --header 'X-API-Key: <x-api-key>'
[
  {
    "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
  }
]

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

Query Parameters

​
api_key
string

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

Response

Successfully retrieved all selling plans

​
frequencyCount
integer<int32>
​
frequencyInterval
enum<string>
Available options:
DAY,
WEEK,
MONTH,
YEAR
​
billingFrequencyCount
integer<int32>
​
payAsYouGoPrepaidBillingFrequencyCount
integer<int32>
​
billingFrequencyInterval
enum<string>
Available options:
DAY,
WEEK,
MONTH,
YEAR
​
frequencyName
string
​
frequencyDescription
string
​
discountOffer
number<double>
​
discountOffer2
number<double>
​
afterCycle1
integer<int32>
​
afterCycle2
integer<int32>
​
discountType
enum<string>
Available options:
PERCENTAGE,
FIXED,
PRICE
​
discountType2
enum<string>
Available options:
PERCENTAGE,
FIXED,
PRICE
​
discountEnabled
boolean
​
discountEnabled2
boolean
​
discountEnabledMasked
boolean
​
discountEnabled2Masked
boolean
​
id
string
​
frequencyType
enum<string>
Available options:
ON_PURCHASE_DAY,
ON_SPECIFIC_DAY
​
specificDayValue
integer<int32>
​
specificMonthValue
integer<int32>
​
specificDayEnabled
boolean
​
maxCycles
integer<int32>
​
minCycles
integer<int32>
​
cutOff
integer<int32>
​
prepaidFlag
string
​
idNew
string
​
planType
enum<string>
Available options:
PAY_AS_YOU_GO,
PREPAID,
ADVANCED_PREPAID,
PAY_AS_YOU_GO_PREPAID
​
deliveryPolicyPreAnchorBehavior
enum<string>
Available options:
ASAP,
NEXT,
$UNKNOWN
​
freeTrialEnabled
boolean
​
freeTrialCount
integer<int32>
​
freeTrialInterval
enum<string>
Available options:
DAY,
WEEK,
MONTH,
YEAR
​
memberOnly
boolean
​
nonMemberOnly
boolean
​
memberInclusiveTags
string
​
memberExclusiveTags
string
​
formFieldJson
string
​
upcomingOrderEmailBuffer
integer<int32>
​
frequencySequence
integer<int32>
​
groupName
string
​
groupId
integer<int64>
​
repeatingCycle
boolean
​
repeatingNumberOfCycle
integer<int32>
​
keepOriginalNextBillingDateAfterTrial
boolean
​
defaultSelectedPlan
boolean
​
frequencyNameTranslations
object
​
inventoryPolicyReserve
enum<string>
Available options:
ON_FULFILLMENT,
ON_SALE,
$UNKNOWN
​
appstleCycles
object[]