get http://{{url}}/v1/customers
Returns all charges for the account
Request query params
Pagination
| field | required[flow] | type | description |
|---|---|---|---|
| skip | - | number | Pagination parameter to skip first n customers from list, default = 0 |
| limit | - | number | Pagination parameter to limit output to n , default = 100 , maximum value = 1000 |
| sortkey | - | string | Sorting key parameter i.e. created_at |
| sortdirection | - | string | Sorting order direction parameter ASC or DESC (DESC by default) |
filters
| field | required | type | description |
|---|---|---|---|
| gateway_id | - | string (24 hex characters) | ID of a gateway with which charges were created |
| payment_source_id | - | string (24 hex characters) | ID of a stored customers payment_source |
| status | - | string | See Status table |
| archived | - | bool | Set to true to show all the archived charges. Default: false |
| reference | - | string | reference |
| company_name | - | string | Company name |
| id | - | string (24 hex characters) | ID of particular customer |
Other
| field | required | type | description |
|---|---|---|---|
| search | - | string | Word of phrase Customer want to search in created charges (search works by fields: first_name, last_name, email, company_name) |