Search customers
GET/customers/search
Search customers.
Authorization Action:
pay:customers:list
Request
Query Parameters
Possible values: >= 1
and <= 100
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
A cursor for pagination across multiple pages of results.
Responses
- 200
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
data object[]required
address object
Two-letter country code (ISO 3166-1 alpha-2).
Address line 1 (e.g., street, block, PO Box, or company name).
Address line 2 (e.g., apartment, suite, unit, or building).
ZIP or postal code.
State, county, province, prefecture, or region.
When the customer's latest invoice is billed by charging automatically, delinquent
is true
if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, delinquent
is true
if the invoice isn't paid by its due date.
The customer's email address.
The customer's full name or business name.
The customer's phone number.
The customer's current subscriptions, if any.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
{
"data": [
{
"address": {
"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postal_code": "string",
"state": "string"
},
"delinquent": true,
"email": "string",
"name": "string",
"phone": "string",
"subscriptions": {},
"id": "string",
"created": 0
}
],
"has_more": true
}