API Reference
Fetch saved subscription customer list V3
GET/v3/customersFetch list of all saved customers (individual customers and subscription customers). Customers are defined by the individual, unique merchant customer ID.
Request
Query Params
itemsPerPage
string
optional
Limit of results
Default:
10
Match pattern:
^[1-9][0-9]*$
page
string
optional
Page of results
Default:
1
Match pattern:
^[1-9][0-9]*$
direction
enum<string>
optional
Direction of order
Allowed values:
ascdesc
Default:
asc
sortBy
enum<string>
optional
column sorting
Allowed value:
createdAt
Default:
createdAt
Header Params
request-id
string
required
A unique identifier generated by requesting client
>= 38 characters<= 1024 characters
Example:
|us04oqdnzFQVr0rITD9/c9OvDRE2sXVfwerv.
Match pattern:
^[a-zA-Z0-9?&:_|\-\/=+.,#\s]+$
Request samples
Responses
OK(200)
Not Found(404)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
data
array[object (CppCustomerV3) {10}]
required
id
string <uuid>
required
merchantCustomerId
string
required
>= 1 characters<= 128 characters
status
enum<string>
required
Allowed values:
newconfirmed
firstName
string
optional
<= 128 characters
lastName
string
optional
<= 128 characters
userName
string
optional
<= 128 characters
description
string
optional
<= 256 characters
email
string <email>
optional
dragonTermsAccepted
boolean
required
createdAt
string <date-time>
required
meta
object
Meta
itemsPerPage
string
optional
Default:
10
Match pattern:
^[1-9][0-9]*$
page
string
optional
Default:
1
Match pattern:
^[1-9][0-9]*$
direction
enum<string>
optional
Allowed values:
ascdesc
Default:
asc
sortBy
enum<string>
optional
Allowed value:
createdAt
Default:
createdAt
Example
{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"merchantCustomerId": "string",
"status": "new",
"firstName": "string",
"lastName": "string",
"userName": "string",
"description": "string",
"email": "user@example.com",
"dragonTermsAccepted": true,
"createdAt": "2019-08-24T14:15:22.123Z"
}
],
"meta": {
"itemsPerPage": "10",
"page": "1",
"direction": "asc",
"sortBy": "createdAt"
}
}Modified at 10 days ago