Skip to main content
GET
List Customers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
enum<string>

The lifecycle status of the customer. Defaults to Active when omitted on creation.

Available options:
Active,
Inactive,
Suspended,
Trial
limit
number
default:10
Required range: 1 <= x <= 1000
cursor
string

Response

RequestSuccess

customers
object[]
required
total
number
required
hasMore
boolean
required
nextCursor
string