Skip to main content
GET
/
subscriptions
/
cp
/
api
/
upcoming-order-rewards
cURL
curl --request GET \
  --url https://www.myshop.com/apps/subscriptions/cp/api/upcoming-order-rewards
import requests

url = "https://www.myshop.com/apps/subscriptions/cp/api/upcoming-order-rewards"

response = requests.get(url)

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

fetch('https://www.myshop.com/apps/subscriptions/cp/api/upcoming-order-rewards', 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/upcoming-order-rewards';
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/upcoming-order-rewards",
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/upcoming-order-rewards"

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/upcoming-order-rewards")

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
{
  "contractId": 123,
  "currentCycle": 123,
  "enabled": true,
  "nextFreeProductInOrders": 123,
  "orders": [
    {
      "billingAttemptId": 123,
      "billingCycle": 123,
      "billingDate": "2023-11-07T05:31:56Z",
      "discountType": "<string>",
      "discountValue": 123,
      "freeProducts": [
        {
          "freeProductHandle": "<string>",
          "freeVariantId": 123,
          "productTitle": "<string>"
        }
      ],
      "orderNumber": 123,
      "shippingPrice": 123,
      "status": "<string>"
    }
  ]
}

Query Parameters

contractId
integer<int64>
required
sellingPlanId
string
required

Response

200 - */*

OK

contractId
integer<int64>
currentCycle
integer<int32>
enabled
boolean
nextFreeProductInOrders
integer<int32>
orders
object[]