Skip to main content
GET
/
api
/
external
/
v2
/
subscription-contract-details
/
customers
Retrieve customers with subscriptions
curl --request GET \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-contract-details/customers \
  --header 'X-API-Key: <x-api-key>'
import requests

url = "https://subscription-admin.appstle.com/api/external/v2/subscription-contract-details/customers"

headers = {"X-API-Key": "<x-api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

fetch('https://subscription-admin.appstle.com/api/external/v2/subscription-contract-details/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://subscription-admin.appstle.com/api/external/v2/subscription-contract-details/customers';
const options = {method: 'GET', headers: {'X-API-Key': '<x-api-key>'}};

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://subscription-admin.appstle.com/api/external/v2/subscription-contract-details/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <x-api-key>"
],
]);

$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://subscription-admin.appstle.com/api/external/v2/subscription-contract-details/customers"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<x-api-key>")

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://subscription-admin.appstle.com/api/external/v2/subscription-contract-details/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body
[
  {
    "activeSubscriptions": 123,
    "customerId": 123,
    "email": "<string>",
    "inActiveSubscriptions": 123,
    "lifetimeValue": 123,
    "name": "<string>",
    "nextOrderDate": "2023-11-07T05:31:56Z"
  }
]
[
{
"activeSubscriptions": 123,
"customerId": 123,
"email": "<string>",
"inActiveSubscriptions": 123,
"lifetimeValue": 123,
"name": "<string>",
"nextOrderDate": "2023-11-07T05:31:56Z"
}
]
[
{
"activeSubscriptions": 123,
"customerId": 123,
"email": "<string>",
"inActiveSubscriptions": 123,
"lifetimeValue": 123,
"name": "<string>",
"nextOrderDate": "2023-11-07T05:31:56Z"
}
]

Headers

X-API-Key
string
required

API Key for authentication

Query Parameters

api_key
string

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

name
string

Filter customers by name (partial match supported)

email
string

Filter customers by exact email address

activeMoreThanOneSubscription
boolean
default:false

When true, returns only customers who have more than one active subscription

pageable
object
required

Pagination parameters (page number and size)

Response

Successfully retrieved customer list

activeSubscriptions
integer<int64>
customerId
integer<int64>
email
string
inActiveSubscriptions
integer<int64>
lifetimeValue
number<double>
name
string
nextOrderDate
string<date-time>