Skip to main content
GET
/
api
/
external
/
v2
/
subscription-customers-detail
/
valid
/
{customerId}
Get detailed customer subscription information
curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-customers-detail/valid/{customerId}
import requests

url = "https://membership-admin.appstle.com/api/external/v2/subscription-customers-detail/valid/{customerId}"

response = requests.get(url)

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

fetch('https://membership-admin.appstle.com/api/external/v2/subscription-customers-detail/valid/{customerId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://membership-admin.appstle.com/api/external/v2/subscription-customers-detail/valid/{customerId}';
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://membership-admin.appstle.com/api/external/v2/subscription-customers-detail/valid/{customerId}",
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://membership-admin.appstle.com/api/external/v2/subscription-customers-detail/valid/{customerId}"

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://membership-admin.appstle.com/api/external/v2/subscription-customers-detail/valid/{customerId}")

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",
  "allowDeliveryPriceOverride": true,
  "autoCharge": true,
  "billingDateAfterTrial": "2023-11-07T05:31:56Z",
  "billingPolicyInterval": "<string>",
  "billingPolicyIntervalCount": 123,
  "cancellationFeedback": "<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>",
  "deliveryPolicyInterval": "<string>",
  "deliveryPolicyIntervalCount": 123,
  "dunning": true,
  "emailBouncedOrFailed": true,
  "endsAt": "2023-11-07T05:31:56Z",
  "graphCustomerId": "<string>",
  "graphOrderId": "<string>",
  "graphSubscriptionContractId": "<string>",
  "id": 123,
  "importedId": "<string>",
  "maxCycles": 123,
  "minCycles": 123,
  "nextBillingDate": "2023-11-07T05:31:56Z",
  "orderAmount": 123,
  "orderAmountUSD": 123,
  "orderId": 123,
  "orderName": "<string>",
  "orderNote": "<string>",
  "orderNoteAttributes": "<string>",
  "pausedBySecurityChallenge": true,
  "pausedFromActive": true,
  "pausedOn": "2023-11-07T05:31:56Z",
  "phone": "<string>",
  "startsAt": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "stopUpComingOrderEmail": true,
  "subscriptionContractId": 123,
  "subscriptionCreatedEmailSent": true,
  "trialEndDate": "2023-11-07T05:31:56Z",
  "upcomingSwapRule": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}
[
{
"shop": "<string>",
"activatedOn": "2023-11-07T05:31:56Z",
"allowDeliveryPriceOverride": true,
"autoCharge": true,
"billingDateAfterTrial": "2023-11-07T05:31:56Z",
"billingPolicyInterval": "<string>",
"billingPolicyIntervalCount": 123,
"cancellationFeedback": "<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>",
"deliveryPolicyInterval": "<string>",
"deliveryPolicyIntervalCount": 123,
"dunning": true,
"emailBouncedOrFailed": true,
"endsAt": "2023-11-07T05:31:56Z",
"graphCustomerId": "<string>",
"graphOrderId": "<string>",
"graphSubscriptionContractId": "<string>",
"id": 123,
"importedId": "<string>",
"maxCycles": 123,
"minCycles": 123,
"nextBillingDate": "2023-11-07T05:31:56Z",
"orderAmount": 123,
"orderAmountUSD": 123,
"orderId": 123,
"orderName": "<string>",
"orderNote": "<string>",
"orderNoteAttributes": "<string>",
"pausedBySecurityChallenge": true,
"pausedFromActive": true,
"pausedOn": "2023-11-07T05:31:56Z",
"phone": "<string>",
"startsAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"stopUpComingOrderEmail": true,
"subscriptionContractId": 123,
"subscriptionCreatedEmailSent": true,
"trialEndDate": "2023-11-07T05:31:56Z",
"upcomingSwapRule": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
[
{
"shop": "<string>",
"activatedOn": "2023-11-07T05:31:56Z",
"allowDeliveryPriceOverride": true,
"autoCharge": true,
"billingDateAfterTrial": "2023-11-07T05:31:56Z",
"billingPolicyInterval": "<string>",
"billingPolicyIntervalCount": 123,
"cancellationFeedback": "<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>",
"deliveryPolicyInterval": "<string>",
"deliveryPolicyIntervalCount": 123,
"dunning": true,
"emailBouncedOrFailed": true,
"endsAt": "2023-11-07T05:31:56Z",
"graphCustomerId": "<string>",
"graphOrderId": "<string>",
"graphSubscriptionContractId": "<string>",
"id": 123,
"importedId": "<string>",
"maxCycles": 123,
"minCycles": 123,
"nextBillingDate": "2023-11-07T05:31:56Z",
"orderAmount": 123,
"orderAmountUSD": 123,
"orderId": 123,
"orderName": "<string>",
"orderNote": "<string>",
"orderNoteAttributes": "<string>",
"pausedBySecurityChallenge": true,
"pausedFromActive": true,
"pausedOn": "2023-11-07T05:31:56Z",
"phone": "<string>",
"startsAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"stopUpComingOrderEmail": true,
"subscriptionContractId": 123,
"subscriptionCreatedEmailSent": true,
"trialEndDate": "2023-11-07T05:31:56Z",
"upcomingSwapRule": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
[
{
"shop": "<string>",
"activatedOn": "2023-11-07T05:31:56Z",
"allowDeliveryPriceOverride": true,
"autoCharge": true,
"billingDateAfterTrial": "2023-11-07T05:31:56Z",
"billingPolicyInterval": "<string>",
"billingPolicyIntervalCount": 123,
"cancellationFeedback": "<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>",
"deliveryPolicyInterval": "<string>",
"deliveryPolicyIntervalCount": 123,
"dunning": true,
"emailBouncedOrFailed": true,
"endsAt": "2023-11-07T05:31:56Z",
"graphCustomerId": "<string>",
"graphOrderId": "<string>",
"graphSubscriptionContractId": "<string>",
"id": 123,
"importedId": "<string>",
"maxCycles": 123,
"minCycles": 123,
"nextBillingDate": "2023-11-07T05:31:56Z",
"orderAmount": 123,
"orderAmountUSD": 123,
"orderId": 123,
"orderName": "<string>",
"orderNote": "<string>",
"orderNoteAttributes": "<string>",
"pausedBySecurityChallenge": true,
"pausedFromActive": true,
"pausedOn": "2023-11-07T05:31:56Z",
"phone": "<string>",
"startsAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"stopUpComingOrderEmail": true,
"subscriptionContractId": 123,
"subscriptionCreatedEmailSent": true,
"trialEndDate": "2023-11-07T05:31:56Z",
"upcomingSwapRule": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]

Headers

X-API-Key
string

Path Parameters

customerId
integer<int64>
required

Shopify customer ID

Query Parameters

api_key
string

API Key (Deprecated - Use Header X-API-Key instead)

Response

Customer subscription details successfully retrieved (may be empty list if no subscriptions)

shop
string
required
activatedOn
string<date-time>
allowDeliveryPriceOverride
boolean
autoCharge
boolean
billingDateAfterTrial
string<date-time>
billingPolicyInterval
string
billingPolicyIntervalCount
integer<int32>
cancellationFeedback
string
cancelledOn
string<date-time>
contractAmount
number<double>
contractAmountUSD
number<double>
contractDetailsJSON
string
createdAt
string<date-time>
currencyCode
string
customerEmail
string
customerFirstName
string
customerId
integer<int64>
customerLastName
string
customerName
string
deliveryPolicyInterval
string
deliveryPolicyIntervalCount
integer<int32>
dunning
boolean
emailBouncedOrFailed
boolean
endsAt
string<date-time>
graphCustomerId
string
graphOrderId
string
graphSubscriptionContractId
string
id
integer<int64>
importedId
string
maxCycles
integer<int32>
minCycles
integer<int32>
nextBillingDate
string<date-time>
orderAmount
number<double>
orderAmountUSD
number<double>
orderId
integer<int64>
orderName
string
orderNote
string
orderNoteAttributes
string
pausedBySecurityChallenge
boolean
pausedFromActive
boolean
pausedOn
string<date-time>
phone
string
startsAt
string<date-time>
status
string
stopUpComingOrderEmail
boolean
subscriptionContractId
integer<int64>
subscriptionCreatedEmailSent
boolean
subscriptionCreatedEmailSentStatus
enum<string>
Available options:
SENT,
UNSENT,
FAILED,
EMAIL_SETTINGS_DISABLED,
CUSTOMER_PAYMENT_EMPTY,
CONTRACT_PAUSED_STATUS
subscriptionCreatedSmsSentStatus
enum<string>
Available options:
SENT,
UNSENT,
FAILED,
SMS_SETTINGS_DISABLED,
CUSTOMER_PAYMENT_EMPTY,
CONTRACT_PAUSED_STATUS,
PHONE_NUMBER_EMPTY
trialEndDate
string<date-time>
upcomingSwapRule
string
updatedAt
string<date-time>