Membership Contracts
Get membership contract list
Retrieves a paginated list of membership contracts with advanced filtering capabilities. This endpoint provides comprehensive access to all membership contracts in your store with flexible query options.
Key Information Returned:
- Contract Details: Contract ID, status, creation date, billing cycle
- Customer Information: Customer name, email, Shopify customer ID
- Membership Items: Products, variants, quantities in membership
- Billing Information: Next billing date, billing frequency, pricing
- Delivery Details: Shipping address, delivery method, next delivery date
- Plan Information: Membership plan type, selling plan IDs
- Status Tracking: Active, paused, cancelled, expired states
Filtering Capabilities:
- Date Ranges: Filter by creation date or next billing date
- Customer Search: Search by customer name or email
- Status Filter: Filter by contract status (active, paused, cancelled)
- Plan Type: Filter by membership plan type
- Billing Frequency: Filter by billing interval (weekly, monthly, etc.)
- Product/Variant: Find contracts containing specific products or variants
- Order Name: Search by Shopify order name/number
- Selling Plan: Filter by Shopify selling plan IDs
- Special Filters: Contracts with deleted products or bounced emails
Pagination:
- Supports standard pagination parameters (page, size, sort)
- Returns pagination headers for total count and navigation
- Default page size configurable via request parameters
Use Cases:
- Export membership data to external CRM or analytics systems
- Build custom membership dashboards and reports
- Sync membership data with external platforms
- Identify memberships needing attention (bounced emails, deleted products)
- Generate membership activity reports by date range
- Find all memberships for a specific product or variant
- Monitor membership health and churn metrics
Authentication: Requires API key authentication via X-API-Key header or api_key parameter
GET
/
api
/
external
/
v2
/
subscription-contract-details
Get membership contract list
curl --request GET \
--url https://membership-admin.appstle.com/api/external/v2/subscription-contract-detailsimport requests
url = "https://membership-admin.appstle.com/api/external/v2/subscription-contract-details"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://membership-admin.appstle.com/api/external/v2/subscription-contract-details', 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-contract-details';
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-contract-details",
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-contract-details"
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-contract-details")
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,
"nextActivationDate": "2023-11-07T05:31:56Z",
"nextBillingDate": "2023-11-07T05:31:56Z",
"orderAmount": 123,
"orderAmountUSD": 123,
"orderId": 123,
"orderName": "<string>",
"orderNote": "<string>",
"orderNoteAttributes": "<string>",
"pauseDurationCycle": 123,
"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,
"subscriptionCreatedEmailSentStatus": "SENT",
"subscriptionCreatedSmsSentStatus": "SENT",
"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,
"nextActivationDate": "2023-11-07T05:31:56Z",
"nextBillingDate": "2023-11-07T05:31:56Z",
"orderAmount": 123,
"orderAmountUSD": 123,
"orderId": 123,
"orderName": "<string>",
"orderNote": "<string>",
"orderNoteAttributes": "<string>",
"pauseDurationCycle": 123,
"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,
"subscriptionCreatedEmailSentStatus": "SENT",
"subscriptionCreatedSmsSentStatus": "SENT",
"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,
"nextActivationDate": "2023-11-07T05:31:56Z",
"nextBillingDate": "2023-11-07T05:31:56Z",
"orderAmount": 123,
"orderAmountUSD": 123,
"orderId": 123,
"orderName": "<string>",
"orderNote": "<string>",
"orderNoteAttributes": "<string>",
"pauseDurationCycle": 123,
"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,
"subscriptionCreatedEmailSentStatus": "SENT",
"subscriptionCreatedSmsSentStatus": "SENT",
"trialEndDate": "2023-11-07T05:31:56Z",
"upcomingSwapRule": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]Headers
Query Parameters
API Key (Deprecated - Use Header X-API-Key instead)
Filter contracts created on or after this date
Filter contracts created on or before this date
Filter contracts with next billing date on or after this date
Filter contracts with next billing date on or before this date
Filter by specific membership contract ID
Filter by customer name or email (partial match)
Filter by Shopify order name
Filter by membership status
Available options:
ACTIVE, PAUSED, CANCELLED, FAILED, EXPIRED Filter by billing frequency count (e.g., 1 for every 1 month)
Filter by billing frequency interval
Available options:
DAY, WEEK, MONTH, YEAR Filter by plan type (PAY_AS_YOU_GO or PREPAID)
Available options:
PAY_AS_YOU_GO, PREPAID Filter by record type (CONTRACT or SELLING_PLAN_GROUP)
Filter by Shopify product ID
Filter by Shopify product variant ID
Filter by selling plan IDs (comma-separated for multiple)
Include only contracts with products deleted from Shopify store
Include only contracts where email notifications bounced or failed
Pagination parameters (page number and size)
Show child attributes
Show child attributes
Response
Membership contracts successfully retrieved with pagination headers
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 ⌘I
Get membership contract list
curl --request GET \
--url https://membership-admin.appstle.com/api/external/v2/subscription-contract-detailsimport requests
url = "https://membership-admin.appstle.com/api/external/v2/subscription-contract-details"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://membership-admin.appstle.com/api/external/v2/subscription-contract-details', 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-contract-details';
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-contract-details",
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-contract-details"
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-contract-details")
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,
"nextActivationDate": "2023-11-07T05:31:56Z",
"nextBillingDate": "2023-11-07T05:31:56Z",
"orderAmount": 123,
"orderAmountUSD": 123,
"orderId": 123,
"orderName": "<string>",
"orderNote": "<string>",
"orderNoteAttributes": "<string>",
"pauseDurationCycle": 123,
"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,
"subscriptionCreatedEmailSentStatus": "SENT",
"subscriptionCreatedSmsSentStatus": "SENT",
"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,
"nextActivationDate": "2023-11-07T05:31:56Z",
"nextBillingDate": "2023-11-07T05:31:56Z",
"orderAmount": 123,
"orderAmountUSD": 123,
"orderId": 123,
"orderName": "<string>",
"orderNote": "<string>",
"orderNoteAttributes": "<string>",
"pauseDurationCycle": 123,
"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,
"subscriptionCreatedEmailSentStatus": "SENT",
"subscriptionCreatedSmsSentStatus": "SENT",
"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,
"nextActivationDate": "2023-11-07T05:31:56Z",
"nextBillingDate": "2023-11-07T05:31:56Z",
"orderAmount": 123,
"orderAmountUSD": 123,
"orderId": 123,
"orderName": "<string>",
"orderNote": "<string>",
"orderNoteAttributes": "<string>",
"pauseDurationCycle": 123,
"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,
"subscriptionCreatedEmailSentStatus": "SENT",
"subscriptionCreatedSmsSentStatus": "SENT",
"trialEndDate": "2023-11-07T05:31:56Z",
"upcomingSwapRule": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
]