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
import requests

url = "https://www.myshop.com/apps/subscriptions/cp/api/data/v2/products-selling-plans"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://www.myshop.com/apps/subscriptions/cp/api/data/v2/products-selling-plans', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://www.myshop.com/apps/subscriptions/cp/api/data/v2/products-selling-plans';
const options = {method: 'GET'};

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://www.myshop.com/apps/subscriptions/cp/api/data/v2/products-selling-plans",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://www.myshop.com/apps/subscriptions/cp/api/data/v2/products-selling-plans"

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

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://www.myshop.com/apps/subscriptions/cp/api/data/v2/products-selling-plans")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
[
  {
    "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
  }
]

Query Parameters

productIds
integer<int64>[]
required

Product IDs

variantIds
integer<int64>[]

Variant IDs

Response

200 - */*

OK

afterCycle1
integer<int32>
afterCycle2
integer<int32>
appstleCycles
object[]
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[]
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
frequencySequence
integer<int32>
frequencyType
enum<string>
Available options:
ON_PURCHASE_DAY,
ON_SPECIFIC_DAY,
ON_FIXED_DATES
groupId
integer<int64>
groupName
string
id
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>