Skip to main content
GET
Retrieve customers with subscriptions

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

page
integer
default:0

Zero-based page index (0..N)

Required range: x >= 0
size
integer
default:20

The size of the page to be returned

Required range: x >= 1
sort
string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

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>