List customers

Returns the profile's customers, sorted by last name, one page at a time.

  • Each row is a short summary, not the full customer. To get addresses and organisation details, show the customer.
  • Filters combine: a row must match every filter you send.
  • Page size is 20 by default, up to 100.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

Your merchant profile ID. Required in every request.

Find it in the BillPro dashboard address, after /profiles/. For example, in /profiles/1234/orders the profile ID is 1234.

Query Params
string

Search term. Matches part of the email, your customer reference (customer_id), the full name or the organisation name. Not case-sensitive. The full name is matched as first name then last name: emma smith matches, smith emma doesn't.

status
array of strings

One or more statuses: active or dormant. Send a single value (status=active), a comma list (status=active,dormant) or a repeated array parameter (status[]=active&status[]=dormant). Leave it out to list every status. Other values don't return an error, but can return unexpected rows, so send only these two.

status
Allowed:
string
enum

What to sort by: first_name, last_name, email, orders (number of orders), created (creation date) or id. id is the customer's id, not your customer_id. name sorts by last name only, like last_name. Any other value sorts by last name, without an error. Leave it out to sort by last name.

Allowed:
string
enum
Defaults to asc

Sort direction: asc or desc. Default asc. Any other value uses asc. Also applies to the default last-name sort.

Allowed:
integer
Defaults to 1

Page number, starting at 1. A page past the last one returns 404, so stop when next_page is null. Send a positive whole number: 0, negative or non-numeric values return 500.

integer
≤ 100
Defaults to 20

Customers per page. Default 20. Values above 100 are reduced to 100. Other invalid values use 20.

Responses

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