Subscription Data
Get compatible selling-plan frequencies
Get compatible selling-plan frequency options for a subscription contract
GET
/
subscriptions
/
cp
/
api
/
data
/
v2
/
compatible-selling-plan-frequencies
Get compatible selling-plan frequencies
curl --request GET \
--url https://www.myshop.com/apps/subscriptions/cp/api/data/v2/compatible-selling-plan-frequenciesimport requests
url = "https://www.myshop.com/apps/subscriptions/cp/api/data/v2/compatible-selling-plan-frequencies"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://www.myshop.com/apps/subscriptions/cp/api/data/v2/compatible-selling-plan-frequencies', 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/compatible-selling-plan-frequencies';
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/compatible-selling-plan-frequencies",
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/compatible-selling-plan-frequencies"
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/compatible-selling-plan-frequencies")
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{
"eligibleLineCount": 123,
"eligibleLineIds": [
"<string>"
],
"ignoredLineCount": 123,
"ignoredLineIds": [
"<string>"
],
"noOptionsReason": {
"code": "<string>",
"eligibleLineIds": [
"<string>"
],
"lineIdsWithoutMatchingPlans": [
"<string>"
],
"message": "<string>"
},
"options": [
{
"billingFrequencyCount": 123,
"deliveryFrequencyCount": 123,
"frequencyDescription": "<string>",
"frequencyKey": "<string>",
"frequencyName": "<string>",
"frequencySequence": 123,
"lineMappings": [
{
"groupId": 123,
"groupName": "<string>",
"lineId": "<string>",
"productId": 123,
"sellingPlanId": "<string>",
"sellingPlanName": "<string>",
"variantId": 123
}
],
"payAsYouGoPrepaidBillingFrequencyCount": 123,
"prepaidFlag": "<string>",
"representativeSellingPlanId": "<string>",
"specificDayEnabled": true,
"specificDayValue": 123,
"specificMonthValue": 123
}
]
}List subscription products available to the customer
Previous
List products with their selling plans (v2)
Next
⌘I
Get compatible selling-plan frequencies
curl --request GET \
--url https://www.myshop.com/apps/subscriptions/cp/api/data/v2/compatible-selling-plan-frequenciesimport requests
url = "https://www.myshop.com/apps/subscriptions/cp/api/data/v2/compatible-selling-plan-frequencies"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://www.myshop.com/apps/subscriptions/cp/api/data/v2/compatible-selling-plan-frequencies', 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/compatible-selling-plan-frequencies';
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/compatible-selling-plan-frequencies",
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/compatible-selling-plan-frequencies"
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/compatible-selling-plan-frequencies")
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{
"eligibleLineCount": 123,
"eligibleLineIds": [
"<string>"
],
"ignoredLineCount": 123,
"ignoredLineIds": [
"<string>"
],
"noOptionsReason": {
"code": "<string>",
"eligibleLineIds": [
"<string>"
],
"lineIdsWithoutMatchingPlans": [
"<string>"
],
"message": "<string>"
},
"options": [
{
"billingFrequencyCount": 123,
"deliveryFrequencyCount": 123,
"frequencyDescription": "<string>",
"frequencyKey": "<string>",
"frequencyName": "<string>",
"frequencySequence": 123,
"lineMappings": [
{
"groupId": 123,
"groupName": "<string>",
"lineId": "<string>",
"productId": 123,
"sellingPlanId": "<string>",
"sellingPlanName": "<string>",
"variantId": 123
}
],
"payAsYouGoPrepaidBillingFrequencyCount": 123,
"prepaidFlag": "<string>",
"representativeSellingPlanId": "<string>",
"specificDayEnabled": true,
"specificDayValue": 123,
"specificMonthValue": 123
}
]
}