Membership Contracts

Get membership/subscription contract list

Retrieves a paginated list of membership/subscription contracts with advanced filtering capabilities. This endpoint provides comprehensive access to all subscription 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
Subscription Items: Products, variants, quantities in subscription
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 subscription data to external CRM or analytics systems
Build custom subscription dashboards and reports
Sync membership data with external platforms
Identify subscriptions needing attention (bounced emails, deleted products)
Generate subscription activity reports by date range
Find all subscriptions for a specific product or variant
Monitor subscription health and churn metrics

Authentication: Requires API key authentication via X-API-Key header or api_key parameter

GET

api

external

subscription-contract-details

Get membership/subscription contract list

curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-contract-details

import 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,
  "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

Query Parameters

api_key

string

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

fromCreatedDate

string<date-time>

Filter contracts created on or after this date

toCreatedDate

string<date-time>

Filter contracts created on or before this date

fromNextDate

string<date-time>

Filter contracts with next billing date on or after this date

toNextDate

string<date-time>

Filter contracts with next billing date on or before this date

subscriptionContractId

string

Filter by specific subscription/membership contract ID

customerName

string

Filter by customer name or email (partial match)

orderName

string

Filter by Shopify order name

status

enum<string>

Filter by subscription status

Available options:

ACTIVE,

PAUSED,

CANCELLED,

FAILED,

EXPIRED

billingPolicyIntervalCount

integer<int32>

Filter by billing frequency count (e.g., 1 for every 1 month)

billingPolicyInterval

enum<string>

Filter by billing frequency interval

Available options:

DAY,

WEEK,

MONTH,

YEAR

planType

enum<string>

Filter by plan type (PAY_AS_YOU_GO or PREPAID)

Available options:

PAY_AS_YOU_GO,

PREPAID

recordType

string

Filter by record type (CONTRACT or SELLING_PLAN_GROUP)

productId

integer<int64>

Filter by Shopify product ID

variantId

integer<int64>

Filter by Shopify product variant ID

sellingPlanIds

string

Filter by selling plan IDs (comma-separated for multiple)

havingProductsDeletedFromStore

boolean

default:false

Include only contracts with products deleted from Shopify store

emailBouncedOrFailed

boolean

default:false

Include only contracts where email notifications bounced or failed

pageable

object

required

Pagination parameters (page number and size)

Show child attributes

Response

Subscription contracts successfully retrieved with pagination headers

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

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>

Add product line item to subscription contract

Get billing interval options for selling plans

Get membership/subscription contract list

curl --request GET \
  --url https://membership-admin.appstle.com/api/external/v2/subscription-contract-details

import 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,
  "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"
  }
]