List customers

Lists all customers associated with the authenticated entity. The request must include a valid API key with appropriate permissions. Returns a list of customers that can be filtered by various parameters. This endpoint allows you to retrieve and manage your customer base, including viewing their payment methods and merchant relationships

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Optional filter to retrieve a specific customer by their unique identifier. If provided, returns only the customer matching this ID

string

Optional filter to retrieve all customers associated with a specific payment method. Useful for filtering customers when managing multiple payment methods

string

Optional filter to retrieve all customers associated with a specific merchant. Useful for filtering customers when managing multiple merchants

string

Optional filter to retrieve all customers associated with a specific customer reference ID. Useful for filtering customers when managing multiple customers

string
deprecated

Optional filter to retrieve all customers associated with a specific subscription. Useful for filtering customers when managing multiple subscriptions

double

Optional pagination parameter to specify the page number of the results to return. Default is 1 which is the first page.

double

Optional pagination parameter to specify the number of results per page. Default is 25, maximum is 100.

string

Optional sorting parameter to specify the field to sort the results by. Valid options are "customerId", "customerRefId", and "dateCreated". Default is "dateCreated".

string

Optional sorting parameter to specify the direction to sort the results by. Valid options are "asc" and "desc". Default is "desc".

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json