Subscription Plans

Get all selling plans across all subscription groups

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

GET

api

external

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>'

import requests

url = "https://subscription-admin.appstle.com/api/external/v2/subscription-groups/all-selling-plans"

headers = {"X-API-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://subscription-admin.appstle.com/api/external/v2/subscription-groups/all-selling-plans', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://subscription-admin.appstle.com/api/external/v2/subscription-groups/all-selling-plans';
const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://subscription-admin.appstle.com/api/external/v2/subscription-groups/all-selling-plans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://subscription-admin.appstle.com/api/external/v2/subscription-groups/all-selling-plans"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://subscription-admin.appstle.com/api/external/v2/subscription-groups/all-selling-plans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "afterCycle1": 0,
    "billingFrequencyCount": 1,
    "billingFrequencyInterval": "MONTH",
    "discountEnabled": true,
    "discountOffer": 10,
    "discountType": "PERCENTAGE",
    "frequencyCount": 1,
    "frequencyDescription": "Save 10% on monthly deliveries",
    "frequencyInterval": "MONTH",
    "frequencyName": "Delivered Monthly",
    "frequencyType": "ON_PURCHASE_DAY",
    "groupId": 123456789,
    "groupName": "Monthly Coffee Subscription",
    "id": "gid://shopify/SellingPlan/111111",
    "inventoryPolicyReserve": "ON_SALE",
    "maxCycles": null,
    "memberOnly": false,
    "minCycles": 3,
    "planType": "PAY_AS_YOU_GO",
    "upcomingOrderEmailBuffer": 3
  },
  {
    "afterCycle1": 0,
    "billingFrequencyCount": 1,
    "billingFrequencyInterval": "WEEK",
    "discountEnabled": true,
    "discountOffer": 15,
    "discountType": "PERCENTAGE",
    "frequencyCount": 1,
    "frequencyDescription": "Fresh tea every week with 15% savings",
    "frequencyInterval": "WEEK",
    "frequencyName": "Weekly Tea Box",
    "groupId": 123456790,
    "groupName": "Premium Tea Collection",
    "id": "gid://shopify/SellingPlan/222222",
    "planType": "PAY_AS_YOU_GO"
  },
  {
    "afterCycle1": 0,
    "billingFrequencyCount": 3,
    "billingFrequencyInterval": "MONTH",
    "discountEnabled": true,
    "discountOffer": 25,
    "discountType": "PERCENTAGE",
    "frequencyCount": 1,
    "frequencyDescription": "Pay upfront for 3 months and save 25%",
    "frequencyInterval": "MONTH",
    "frequencyName": "3-Month Prepaid Coffee",
    "groupId": 123456789,
    "groupName": "Monthly Coffee Subscription",
    "id": "gid://shopify/SellingPlan/333333",
    "maxCycles": 12,
    "payAsYouGoPrepaidBillingFrequencyCount": 3,
    "planType": "PAY_AS_YOU_GO_PREPAID",
    "repeatingCycle": true,
    "repeatingNumberOfCycle": 12
  }
]

[
  {
    "afterCycle1": 123,
    "afterCycle2": 123,
    "appstleCycles": [
      {
        "afterCycle": 3,
        "discountType": "PERCENTAGE",
        "freeProductHandle": "free-gift-product",
        "freeProductTitle": "Ceramic Mug",
        "freeVariantId": 42549172011164,
        "preventDuplicationFreeProduct": true,
        "repeatingCycle": true,
        "repeatingNumberOfCycle": 6,
        "value": 10
      }
    ],
    "billingFrequencyCount": 123,
    "cutOff": 123,
    "defaultSelectedPlan": true,
    "discountEnabled": true,
    "discountEnabled2": true,
    "discountEnabled2Masked": true,
    "discountEnabledMasked": true,
    "discountOffer": 123,
    "discountOffer2": 123,
    "fixedBillingDates": [
      {
        "day": 123,
        "month": 123
      }
    ],
    "formFieldJson": "<string>",
    "freeTrialCount": 123,
    "freeTrialEnabled": true,
    "frequencyCount": 123,
    "frequencyDescription": "<string>",
    "frequencyName": "<string>",
    "frequencyNameTranslations": {},
    "frequencySequence": 123,
    "groupId": 123,
    "groupName": "<string>",
    "id": "<string>",
    "idNew": "<string>",
    "keepOriginalNextBillingDateAfterTrial": true,
    "maxCycles": 123,
    "memberExclusiveTags": "<string>",
    "memberInclusiveTags": "<string>",
    "memberOnly": true,
    "minCycles": 123,
    "nonMemberOnly": true,
    "payAsYouGoPrepaidBillingFrequencyCount": 123,
    "prepaidFlag": "<string>",
    "repeatingCycle": true,
    "repeatingNumberOfCycle": 123,
    "specificDayEnabled": true,
    "specificDayValue": 123,
    "specificMonthValue": 123,
    "upcomingOrderEmailBuffer": 123
  }
]

[
  {
    "afterCycle1": 123,
    "afterCycle2": 123,
    "appstleCycles": [
      {
        "afterCycle": 3,
        "discountType": "PERCENTAGE",
        "freeProductHandle": "free-gift-product",
        "freeProductTitle": "Ceramic Mug",
        "freeVariantId": 42549172011164,
        "preventDuplicationFreeProduct": true,
        "repeatingCycle": true,
        "repeatingNumberOfCycle": 6,
        "value": 10
      }
    ],
    "billingFrequencyCount": 123,
    "cutOff": 123,
    "defaultSelectedPlan": true,
    "discountEnabled": true,
    "discountEnabled2": true,
    "discountEnabled2Masked": true,
    "discountEnabledMasked": true,
    "discountOffer": 123,
    "discountOffer2": 123,
    "fixedBillingDates": [
      {
        "day": 123,
        "month": 123
      }
    ],
    "formFieldJson": "<string>",
    "freeTrialCount": 123,
    "freeTrialEnabled": true,
    "frequencyCount": 123,
    "frequencyDescription": "<string>",
    "frequencyName": "<string>",
    "frequencyNameTranslations": {},
    "frequencySequence": 123,
    "groupId": 123,
    "groupName": "<string>",
    "id": "<string>",
    "idNew": "<string>",
    "keepOriginalNextBillingDateAfterTrial": true,
    "maxCycles": 123,
    "memberExclusiveTags": "<string>",
    "memberInclusiveTags": "<string>",
    "memberOnly": true,
    "minCycles": 123,
    "nonMemberOnly": true,
    "payAsYouGoPrepaidBillingFrequencyCount": 123,
    "prepaidFlag": "<string>",
    "repeatingCycle": true,
    "repeatingNumberOfCycle": 123,
    "specificDayEnabled": true,
    "specificDayValue": 123,
    "specificMonthValue": 123,
    "upcomingOrderEmailBuffer": 123
  }
]

[
  {
    "afterCycle1": 123,
    "afterCycle2": 123,
    "appstleCycles": [
      {
        "afterCycle": 3,
        "discountType": "PERCENTAGE",
        "freeProductHandle": "free-gift-product",
        "freeProductTitle": "Ceramic Mug",
        "freeVariantId": 42549172011164,
        "preventDuplicationFreeProduct": true,
        "repeatingCycle": true,
        "repeatingNumberOfCycle": 6,
        "value": 10
      }
    ],
    "billingFrequencyCount": 123,
    "cutOff": 123,
    "defaultSelectedPlan": true,
    "discountEnabled": true,
    "discountEnabled2": true,
    "discountEnabled2Masked": true,
    "discountEnabledMasked": true,
    "discountOffer": 123,
    "discountOffer2": 123,
    "fixedBillingDates": [
      {
        "day": 123,
        "month": 123
      }
    ],
    "formFieldJson": "<string>",
    "freeTrialCount": 123,
    "freeTrialEnabled": true,
    "frequencyCount": 123,
    "frequencyDescription": "<string>",
    "frequencyName": "<string>",
    "frequencyNameTranslations": {},
    "frequencySequence": 123,
    "groupId": 123,
    "groupName": "<string>",
    "id": "<string>",
    "idNew": "<string>",
    "keepOriginalNextBillingDateAfterTrial": true,
    "maxCycles": 123,
    "memberExclusiveTags": "<string>",
    "memberInclusiveTags": "<string>",
    "memberOnly": true,
    "minCycles": 123,
    "nonMemberOnly": true,
    "payAsYouGoPrepaidBillingFrequencyCount": 123,
    "prepaidFlag": "<string>",
    "repeatingCycle": true,
    "repeatingNumberOfCycle": 123,
    "specificDayEnabled": true,
    "specificDayValue": 123,
    "specificMonthValue": 123,
    "upcomingOrderEmailBuffer": 123
  }
]

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

afterCycle1

integer<int32>

afterCycle2

integer<int32>

appstleCycles

object[]

Show child attributes

billingFrequencyCount

integer<int32>

billingFrequencyInterval

enum<string>

Available options:

DAY,

WEEK,

MONTH,

YEAR

cutOff

integer<int32>

defaultSelectedPlan

boolean

deliveryPolicyPreAnchorBehavior

enum<string>

Available options:

ASAP,

NEXT,

$UNKNOWN

discountEnabled

boolean

discountEnabled2

boolean

discountEnabled2Masked

boolean

discountEnabledMasked

boolean

discountOffer

number<double>

discountOffer2

number<double>

discountType

enum<string>

Available options:

PERCENTAGE,

FIXED,

PRICE

discountType2

enum<string>

Available options:

PERCENTAGE,

FIXED,

PRICE

fixedBillingDates

object[]

Show child attributes

formFieldJson

string

freeTrialCount

integer<int32>

freeTrialEnabled

boolean

freeTrialInterval

enum<string>

Available options:

DAY,

WEEK,

MONTH,

YEAR

frequencyCount

integer<int32>

frequencyDescription

string

frequencyInterval

enum<string>

Available options:

DAY,

WEEK,

MONTH,

YEAR

frequencyName

string

frequencyNameTranslations

object

Show child attributes

frequencySequence

integer<int32>

frequencyType

enum<string>

Available options:

ON_PURCHASE_DAY,

ON_SPECIFIC_DAY,

ON_FIXED_DATES

groupId

integer<int64>

groupName

string

idNew

string

inventoryPolicyReserve

enum<string>

Available options:

ON_FULFILLMENT,

ON_SALE,

$UNKNOWN

keepOriginalNextBillingDateAfterTrial

boolean

maxCycles

integer<int32>

memberExclusiveTags

string

memberInclusiveTags

string

memberOnly

boolean

minCycles

integer<int32>

nonMemberOnly

boolean

payAsYouGoPrepaidBillingFrequencyCount

integer<int32>

planType

enum<string>

Available options:

PAY_AS_YOU_GO,

PREPAID,

ADVANCED_PREPAID,

PAY_AS_YOU_GO_PREPAID

prepaidFlag

string

repeatingCycle

boolean

repeatingNumberOfCycle

integer<int32>

specificDayEnabled

boolean

specificDayValue

integer<int32>

specificMonthValue

integer<int32>

upcomingOrderEmailBuffer

integer<int32>

Create a new subscription group (selling plan group)

Remove products or variants from ALL subscription groups

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>'

import requests

url = "https://subscription-admin.appstle.com/api/external/v2/subscription-groups/all-selling-plans"

headers = {"X-API-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://subscription-admin.appstle.com/api/external/v2/subscription-groups/all-selling-plans', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://subscription-admin.appstle.com/api/external/v2/subscription-groups/all-selling-plans';
const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://subscription-admin.appstle.com/api/external/v2/subscription-groups/all-selling-plans",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://subscription-admin.appstle.com/api/external/v2/subscription-groups/all-selling-plans"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://subscription-admin.appstle.com/api/external/v2/subscription-groups/all-selling-plans")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "afterCycle1": 0,
    "billingFrequencyCount": 1,
    "billingFrequencyInterval": "MONTH",
    "discountEnabled": true,
    "discountOffer": 10,
    "discountType": "PERCENTAGE",
    "frequencyCount": 1,
    "frequencyDescription": "Save 10% on monthly deliveries",
    "frequencyInterval": "MONTH",
    "frequencyName": "Delivered Monthly",
    "frequencyType": "ON_PURCHASE_DAY",
    "groupId": 123456789,
    "groupName": "Monthly Coffee Subscription",
    "id": "gid://shopify/SellingPlan/111111",
    "inventoryPolicyReserve": "ON_SALE",
    "maxCycles": null,
    "memberOnly": false,
    "minCycles": 3,
    "planType": "PAY_AS_YOU_GO",
    "upcomingOrderEmailBuffer": 3
  },
  {
    "afterCycle1": 0,
    "billingFrequencyCount": 1,
    "billingFrequencyInterval": "WEEK",
    "discountEnabled": true,
    "discountOffer": 15,
    "discountType": "PERCENTAGE",
    "frequencyCount": 1,
    "frequencyDescription": "Fresh tea every week with 15% savings",
    "frequencyInterval": "WEEK",
    "frequencyName": "Weekly Tea Box",
    "groupId": 123456790,
    "groupName": "Premium Tea Collection",
    "id": "gid://shopify/SellingPlan/222222",
    "planType": "PAY_AS_YOU_GO"
  },
  {
    "afterCycle1": 0,
    "billingFrequencyCount": 3,
    "billingFrequencyInterval": "MONTH",
    "discountEnabled": true,
    "discountOffer": 25,
    "discountType": "PERCENTAGE",
    "frequencyCount": 1,
    "frequencyDescription": "Pay upfront for 3 months and save 25%",
    "frequencyInterval": "MONTH",
    "frequencyName": "3-Month Prepaid Coffee",
    "groupId": 123456789,
    "groupName": "Monthly Coffee Subscription",
    "id": "gid://shopify/SellingPlan/333333",
    "maxCycles": 12,
    "payAsYouGoPrepaidBillingFrequencyCount": 3,
    "planType": "PAY_AS_YOU_GO_PREPAID",
    "repeatingCycle": true,
    "repeatingNumberOfCycle": 12
  }
]

[
  {
    "afterCycle1": 123,
    "afterCycle2": 123,
    "appstleCycles": [
      {
        "afterCycle": 3,
        "discountType": "PERCENTAGE",
        "freeProductHandle": "free-gift-product",
        "freeProductTitle": "Ceramic Mug",
        "freeVariantId": 42549172011164,
        "preventDuplicationFreeProduct": true,
        "repeatingCycle": true,
        "repeatingNumberOfCycle": 6,
        "value": 10
      }
    ],
    "billingFrequencyCount": 123,
    "cutOff": 123,
    "defaultSelectedPlan": true,
    "discountEnabled": true,
    "discountEnabled2": true,
    "discountEnabled2Masked": true,
    "discountEnabledMasked": true,
    "discountOffer": 123,
    "discountOffer2": 123,
    "fixedBillingDates": [
      {
        "day": 123,
        "month": 123
      }
    ],
    "formFieldJson": "<string>",
    "freeTrialCount": 123,
    "freeTrialEnabled": true,
    "frequencyCount": 123,
    "frequencyDescription": "<string>",
    "frequencyName": "<string>",
    "frequencyNameTranslations": {},
    "frequencySequence": 123,
    "groupId": 123,
    "groupName": "<string>",
    "id": "<string>",
    "idNew": "<string>",
    "keepOriginalNextBillingDateAfterTrial": true,
    "maxCycles": 123,
    "memberExclusiveTags": "<string>",
    "memberInclusiveTags": "<string>",
    "memberOnly": true,
    "minCycles": 123,
    "nonMemberOnly": true,
    "payAsYouGoPrepaidBillingFrequencyCount": 123,
    "prepaidFlag": "<string>",
    "repeatingCycle": true,
    "repeatingNumberOfCycle": 123,
    "specificDayEnabled": true,
    "specificDayValue": 123,
    "specificMonthValue": 123,
    "upcomingOrderEmailBuffer": 123
  }
]

[
  {
    "afterCycle1": 123,
    "afterCycle2": 123,
    "appstleCycles": [
      {
        "afterCycle": 3,
        "discountType": "PERCENTAGE",
        "freeProductHandle": "free-gift-product",
        "freeProductTitle": "Ceramic Mug",
        "freeVariantId": 42549172011164,
        "preventDuplicationFreeProduct": true,
        "repeatingCycle": true,
        "repeatingNumberOfCycle": 6,
        "value": 10
      }
    ],
    "billingFrequencyCount": 123,
    "cutOff": 123,
    "defaultSelectedPlan": true,
    "discountEnabled": true,
    "discountEnabled2": true,
    "discountEnabled2Masked": true,
    "discountEnabledMasked": true,
    "discountOffer": 123,
    "discountOffer2": 123,
    "fixedBillingDates": [
      {
        "day": 123,
        "month": 123
      }
    ],
    "formFieldJson": "<string>",
    "freeTrialCount": 123,
    "freeTrialEnabled": true,
    "frequencyCount": 123,
    "frequencyDescription": "<string>",
    "frequencyName": "<string>",
    "frequencyNameTranslations": {},
    "frequencySequence": 123,
    "groupId": 123,
    "groupName": "<string>",
    "id": "<string>",
    "idNew": "<string>",
    "keepOriginalNextBillingDateAfterTrial": true,
    "maxCycles": 123,
    "memberExclusiveTags": "<string>",
    "memberInclusiveTags": "<string>",
    "memberOnly": true,
    "minCycles": 123,
    "nonMemberOnly": true,
    "payAsYouGoPrepaidBillingFrequencyCount": 123,
    "prepaidFlag": "<string>",
    "repeatingCycle": true,
    "repeatingNumberOfCycle": 123,
    "specificDayEnabled": true,
    "specificDayValue": 123,
    "specificMonthValue": 123,
    "upcomingOrderEmailBuffer": 123
  }
]

[
  {
    "afterCycle1": 123,
    "afterCycle2": 123,
    "appstleCycles": [
      {
        "afterCycle": 3,
        "discountType": "PERCENTAGE",
        "freeProductHandle": "free-gift-product",
        "freeProductTitle": "Ceramic Mug",
        "freeVariantId": 42549172011164,
        "preventDuplicationFreeProduct": true,
        "repeatingCycle": true,
        "repeatingNumberOfCycle": 6,
        "value": 10
      }
    ],
    "billingFrequencyCount": 123,
    "cutOff": 123,
    "defaultSelectedPlan": true,
    "discountEnabled": true,
    "discountEnabled2": true,
    "discountEnabled2Masked": true,
    "discountEnabledMasked": true,
    "discountOffer": 123,
    "discountOffer2": 123,
    "fixedBillingDates": [
      {
        "day": 123,
        "month": 123
      }
    ],
    "formFieldJson": "<string>",
    "freeTrialCount": 123,
    "freeTrialEnabled": true,
    "frequencyCount": 123,
    "frequencyDescription": "<string>",
    "frequencyName": "<string>",
    "frequencyNameTranslations": {},
    "frequencySequence": 123,
    "groupId": 123,
    "groupName": "<string>",
    "id": "<string>",
    "idNew": "<string>",
    "keepOriginalNextBillingDateAfterTrial": true,
    "maxCycles": 123,
    "memberExclusiveTags": "<string>",
    "memberInclusiveTags": "<string>",
    "memberOnly": true,
    "minCycles": 123,
    "nonMemberOnly": true,
    "payAsYouGoPrepaidBillingFrequencyCount": 123,
    "prepaidFlag": "<string>",
    "repeatingCycle": true,
    "repeatingNumberOfCycle": 123,
    "specificDayEnabled": true,
    "specificDayValue": 123,
    "specificMonthValue": 123,
    "upcomingOrderEmailBuffer": 123
  }
]