Search customers

GET 
https://apis.<domain>/customers/search

Authorization: http

name: bearerTokentype: httpscheme: bearerin: headerdescription: Authorization Header: `Authorization: Bearer <user_token>`

Search customers.

Authorization Action:

pay:customers:list

Request

Query Parameters

query stringrequired
expand string[]
limit number

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.

page string

A cursor for pagination across multiple pages of results.

Responses

200

application/json

Schema

Schema

data object[]required
Array [
address object
city string
country string
Two-letter country code (ISO 3166-1 alpha-2).
line1 string
Address line 1 (e.g., street, block, PO Box, or company name).
line2 string
Address line 2 (e.g., apartment, suite, unit, or building).
postal_code string
ZIP or postal code.
state string
State, county, province, prefecture, or region.
delinquent booleanrequired
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.
email string
The customer's email address.
name string
The customer's full name or business name.
phone string
The customer's phone number.
subscriptions object
The customer's current subscriptions, if any.
id stringrequired
Unique identifier for the object.
created numberrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
]
has_more booleanrequired

Example (from schema)

{
  "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
}

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://apis.<domain>/customers/search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://apis.<domain>

Auth

Bearer Token

Parameters

query — queryrequired

expand — query

limit — query

page — query