Customers

List Customers

Retrieve a list of customers for the merchant with optional filtering and cursor-based pagination.

To look up a single customer by its vault ID, use Get Customer; to look up a specific billing address, use Get Billing Address.

get/v5/customers

Request

first_namestring

Filter by first name

last_namestring

Filter by last name

emailstring email

Filter by email address

account_numberstring

Filter by the last 4 digits of the payment account number.

date_fromstring date

Filter results created on or after this date. Must be a valid calendar date in YYYY-MM-DD format.

date_tostring date

Filter results created on or before this date. Must be a valid calendar date in YYYY-MM-DD format.

cursorstring

Cursor for pagination, returned as next_cursor on the previous page. Omit for the first page.

per_pageinteger

Number of results to return per page (default: 10, max: 100).

Success

per_pageinteger

next_cursorstring nullable

Cursor for the next page. Pass it as the cursor parameter on the next request. Omitted when there are no more results.

No recorded changes to this operation across all 1 revision of this API.