Subscription Contracts
Get valid subscription contracts for a customer
GET
/
subscriptions
/
cp
/
api
/
subscription-customers-detail
/
valid
/
{id}
Get valid subscription contracts for a customer
curl --request GET \
--url https://www.myshop.com/apps/subscriptions/cp/api/subscription-customers-detail/valid/{id}import requests
url = "https://www.myshop.com/apps/subscriptions/cp/api/subscription-customers-detail/valid/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://www.myshop.com/apps/subscriptions/cp/api/subscription-customers-detail/valid/{id}', 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/subscription-customers-detail/valid/{id}';
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/subscription-customers-detail/valid/{id}",
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/subscription-customers-detail/valid/{id}"
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/subscription-customers-detail/valid/{id}")
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[
{
"shop": "<string>",
"activatedOn": "2023-11-07T05:31:56Z",
"allowDeliveryAddressOverride": true,
"allowDeliveryPriceOverride": true,
"autoCharge": true,
"billingCountryCode": "<string>",
"billingDateAfterTrial": "2023-11-07T05:31:56Z",
"billingPolicyInterval": "<string>",
"billingPolicyIntervalCount": 123,
"cancellationFeedback": "<string>",
"cancellationNote": "<string>",
"cancelledOn": "2023-11-07T05:31:56Z",
"contractAmount": 123,
"contractAmountUSD": 123,
"contractDetailsJSON": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currencyCode": "<string>",
"customerEmail": "<string>",
"customerFirstName": "<string>",
"customerId": 123,
"customerLastName": "<string>",
"customerName": "<string>",
"customerTag": "<string>",
"deletedVariantIds": "<string>",
"deliveryCountryCode": "<string>",
"deliveryPolicyInterval": "<string>",
"deliveryPolicyIntervalCount": 123,
"disableFixEmptyQueue": true,
"emailBouncedOrFailed": true,
"endsAt": "2023-11-07T05:31:56Z",
"graphCustomerId": "<string>",
"graphOrderId": "<string>",
"graphSubscriptionContractId": "<string>",
"id": 123,
"importedId": "<string>",
"lastSuccessfulOrder": "<string>",
"lifetimeValue": 123,
"lifetimeValueUSD": 123,
"maxCycles": 123,
"minCycles": 123,
"nextBillingDate": "2023-11-07T05:31:56Z",
"nextPaidBillingDate": "2023-11-07T05:31:56Z",
"orderAmount": 123,
"orderAmountContractCurrency": 123,
"orderAmountShopCurrency": 123,
"orderAmountUSD": 123,
"orderId": 123,
"orderName": "<string>",
"orderNote": "<string>",
"orderNoteAttributes": "<string>",
"originType": "STORE_FRONT",
"originalContractId": 123,
"pauseDurationCycle": 123,
"pauseFeedback": "<string>",
"pauseReason": "<string>",
"pauseTillDate": "2023-11-07T05:31:56Z",
"pausedFromActive": true,
"pausedOn": "2023-11-07T05:31:56Z",
"pendingCancellationCycle": 123,
"pendingCancellationDate": "2023-11-07T05:31:56Z",
"phone": "<string>",
"queueUpdatedAt": "2023-11-07T05:31:56Z",
"skipPaymentCreateUnpaidOrder": true,
"startsAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"stopUpComingOrderEmail": true,
"subscriptionContractId": 123,
"subscriptionCreatedEmailSent": true,
"subscriptionCreatedEmailSentStatus": "SENT",
"subscriptionCreatedSmsSentStatus": "SENT",
"subscriptionType": "REGULAR_SUBSCRIPTION",
"subscriptionTypeIdentifier": "<string>",
"totalSuccessfulOrders": 123,
"upcomingEmailBufferDays": 123,
"upcomingEmailTaskUrl": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatingQueue": true
}
]Path Parameters
Response
200 - */*
OK
Available options:
STORE_FRONT, IMPORTED, SPLIT_ATTEMPT_BILLING, SPLIT_CONTRACT Available options:
SENT, UNSENT, FAILED, EMAIL_SETTINGS_DISABLED, CUSTOMER_PAYMENT_EMPTY, CONTRACT_PAUSED_STATUS Available options:
SENT, UNSENT, FAILED, SMS_SETTINGS_DISABLED, CUSTOMER_PAYMENT_EMPTY, CONTRACT_PAUSED_STATUS, PHONE_NUMBER_EMPTY Available options:
REGULAR_SUBSCRIPTION, BUILD_A_BOX_CLASSIC, BUILD_A_BOX_SINGLE_PRODUCT, BUNDLING_CLASSIC, BUNDLING_MIX_AND_MATCH, SECTIONED_BUNDLE, VOLUME_DISCOUNT ⌘I
Get valid subscription contracts for a customer
curl --request GET \
--url https://www.myshop.com/apps/subscriptions/cp/api/subscription-customers-detail/valid/{id}import requests
url = "https://www.myshop.com/apps/subscriptions/cp/api/subscription-customers-detail/valid/{id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://www.myshop.com/apps/subscriptions/cp/api/subscription-customers-detail/valid/{id}', 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/subscription-customers-detail/valid/{id}';
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/subscription-customers-detail/valid/{id}",
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/subscription-customers-detail/valid/{id}"
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/subscription-customers-detail/valid/{id}")
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[
{
"shop": "<string>",
"activatedOn": "2023-11-07T05:31:56Z",
"allowDeliveryAddressOverride": true,
"allowDeliveryPriceOverride": true,
"autoCharge": true,
"billingCountryCode": "<string>",
"billingDateAfterTrial": "2023-11-07T05:31:56Z",
"billingPolicyInterval": "<string>",
"billingPolicyIntervalCount": 123,
"cancellationFeedback": "<string>",
"cancellationNote": "<string>",
"cancelledOn": "2023-11-07T05:31:56Z",
"contractAmount": 123,
"contractAmountUSD": 123,
"contractDetailsJSON": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currencyCode": "<string>",
"customerEmail": "<string>",
"customerFirstName": "<string>",
"customerId": 123,
"customerLastName": "<string>",
"customerName": "<string>",
"customerTag": "<string>",
"deletedVariantIds": "<string>",
"deliveryCountryCode": "<string>",
"deliveryPolicyInterval": "<string>",
"deliveryPolicyIntervalCount": 123,
"disableFixEmptyQueue": true,
"emailBouncedOrFailed": true,
"endsAt": "2023-11-07T05:31:56Z",
"graphCustomerId": "<string>",
"graphOrderId": "<string>",
"graphSubscriptionContractId": "<string>",
"id": 123,
"importedId": "<string>",
"lastSuccessfulOrder": "<string>",
"lifetimeValue": 123,
"lifetimeValueUSD": 123,
"maxCycles": 123,
"minCycles": 123,
"nextBillingDate": "2023-11-07T05:31:56Z",
"nextPaidBillingDate": "2023-11-07T05:31:56Z",
"orderAmount": 123,
"orderAmountContractCurrency": 123,
"orderAmountShopCurrency": 123,
"orderAmountUSD": 123,
"orderId": 123,
"orderName": "<string>",
"orderNote": "<string>",
"orderNoteAttributes": "<string>",
"originType": "STORE_FRONT",
"originalContractId": 123,
"pauseDurationCycle": 123,
"pauseFeedback": "<string>",
"pauseReason": "<string>",
"pauseTillDate": "2023-11-07T05:31:56Z",
"pausedFromActive": true,
"pausedOn": "2023-11-07T05:31:56Z",
"pendingCancellationCycle": 123,
"pendingCancellationDate": "2023-11-07T05:31:56Z",
"phone": "<string>",
"queueUpdatedAt": "2023-11-07T05:31:56Z",
"skipPaymentCreateUnpaidOrder": true,
"startsAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"stopUpComingOrderEmail": true,
"subscriptionContractId": 123,
"subscriptionCreatedEmailSent": true,
"subscriptionCreatedEmailSentStatus": "SENT",
"subscriptionCreatedSmsSentStatus": "SENT",
"subscriptionType": "REGULAR_SUBSCRIPTION",
"subscriptionTypeIdentifier": "<string>",
"totalSuccessfulOrders": 123,
"upcomingEmailBufferDays": 123,
"upcomingEmailTaskUrl": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"updatingQueue": true
}
]