Get all selling plans

Retrieves all available selling plans for the customer portal, used to display plan options to customers.

GET /memberships/cp/api/subscription-groups/all-selling-plans

Get all selling plans

cURL

curl --request GET \
  --url https://www.myshop.com/apps/memberships/cp/api/subscription-groups/all-selling-plans

200

[
  {
    "frequencyCount": 123,
    "billingFrequencyCount": 123,
    "frequencyName": "<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,
    "frequencyDescription": "<string>",
    "keepOriginalNextBillingDateAfterTrial": true,
    "planSequence": 123,
    "groupName": "<string>",
    "groupId": 123,
    "memberOnly": true,
    "nonMemberOnly": true,
    "memberInclusiveTags": "<string>",
    "memberExclusiveTags": "<string>",
    "lifeTimeMembership": true,
    "rulesJson": "<string>",
    "allowedForUpgradeDowngrade": true
  }
]

Response

200 - */*

OK

frequencyCount · integer<int32>

frequencyInterval · enum<string>

Available options: DAY, WEEK, MONTH, YEAR

billingFrequencyCount · integer<int32>

billingFrequencyInterval · enum<string>

Available options: DAY, WEEK, MONTH, YEAR

frequencyName · 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

deliveryPolicyPreAnchorBehavior · enum<string>

Available options: ASAP, NEXT, $UNKNOWN

freeTrialEnabled · boolean

freeTrialCount · integer<int32>

freeTrialInterval · enum<string>

Available options: DAY, WEEK, MONTH, YEAR

frequencyDescription · string

keepOriginalNextBillingDateAfterTrial · boolean

planSequence · integer<int32>

groupName · string

groupId · integer<int64>

memberOnly · boolean

nonMemberOnly · boolean

memberInclusiveTags · string

memberExclusiveTags · string

lifeTimeMembership · boolean

rulesJson · string

allowedForUpgradeDowngrade · boolean