Skip to main content
GET
/
subscriptions
/
cp
/
api
/
data
/
v2
/
products-selling-plans
List products with their selling plans (v2)
curl --request GET \
  --url https://www.myshop.com/apps/subscriptions/cp/api/data/v2/products-selling-plans
[
  {
    "frequencyCount": 123,
    "billingFrequencyCount": 123,
    "payAsYouGoPrepaidBillingFrequencyCount": 123,
    "frequencyName": "<string>",
    "frequencyDescription": "<string>",
    "discountOffer": 123,
    "discountOffer2": 123,
    "afterCycle1": 123,
    "afterCycle2": 123,
    "discountEnabled": true,
    "discountEnabled2": true,
    "discountEnabledMasked": true,
    "discountEnabled2Masked": true,
    "id": "<string>",
    "specificDayValue": 123,
    "specificMonthValue": 123,
    "specificDayEnabled": true,
    "maxCycles": 123,
    "minCycles": 123,
    "cutOff": 123,
    "prepaidFlag": "<string>",
    "idNew": "<string>",
    "freeTrialEnabled": true,
    "freeTrialCount": 123,
    "memberOnly": true,
    "nonMemberOnly": true,
    "memberInclusiveTags": "<string>",
    "memberExclusiveTags": "<string>",
    "formFieldJson": "<string>",
    "upcomingOrderEmailBuffer": 123,
    "frequencySequence": 123,
    "groupName": "<string>",
    "groupId": 123,
    "repeatingCycle": true,
    "repeatingNumberOfCycle": 123,
    "keepOriginalNextBillingDateAfterTrial": true,
    "defaultSelectedPlan": true,
    "frequencyNameTranslations": {},
    "appstleCycles": [
      {
        "afterCycle": 3,
        "discountType": "PERCENTAGE",
        "value": 10,
        "freeVariantId": 42549172011164,
        "freeProductHandle": "free-gift-product",
        "repeatingCycle": true,
        "repeatingNumberOfCycle": 6,
        "preventDuplicationFreeProduct": true
      }
    ]
  }
]

Documentation Index

Fetch the complete documentation index at: https://developers.appstle.com/llms.txt

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

Query Parameters

​
productIds
integer<int64>[]
required

Product IDs

​
variantIds
integer<int64>[]

Variant IDs

Response

200 - */*

OK

​
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[]