Skip to main content
GET
/
api
/
v1
/
customers
/
search
curl -G "https://api-sandbox.paywithsoap.com/api/v1/customers/search" \
  -H "Authorization: YOUR_API_KEY" \
  --data-urlencode "email=customer@example.com"

{
  "results": [
    {
      "id": "cus_pQsQ4kz3Af6Mb9rCupnWj6VFzxJsmkYK",
      "internal_id": "3f1b8c4e-7c2e-4c2c-8d2f-179cf0efb36b",
      "email": "customer@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "phone_number": "8008001234",
      "created_at": "2026-05-31T18:26:43.069Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.paywithsoap.com/llms.txt

Use this file to discover all available pages before exploring further.

Search for an existing customer belonging to your business by email and/or phone number. Use this to look up a Soap customer_id before creating a checkout, or to check whether a customer already exists. Results are always scoped to the merchant whose API key is used.
At least one of email or phone_number must be supplied. When both are provided, the customer must match both values (AND semantics). Email matching is case-insensitive; phone numbers are normalized to 10 digits (a leading +1 and any non-digit characters are stripped).
curl -G "https://api-sandbox.paywithsoap.com/api/v1/customers/search" \
  -H "Authorization: YOUR_API_KEY" \
  --data-urlencode "email=customer@example.com"

{
  "results": [
    {
      "id": "cus_pQsQ4kz3Af6Mb9rCupnWj6VFzxJsmkYK",
      "internal_id": "3f1b8c4e-7c2e-4c2c-8d2f-179cf0efb36b",
      "email": "customer@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "phone_number": "8008001234",
      "created_at": "2026-05-31T18:26:43.069Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key

Query Parameters

​
email
string

Customer email. Case-insensitive. At least one of email or phone_number must be supplied.

Example:

"john@acme.com"

​
phone_number
string

US phone number. Non-digit characters and a leading +1 are stripped; the normalized form must be 10 digits. At least one of email or phone_number must be supplied.

Example:

"8008001234"

Response

Search results. Always returns a results array, possibly empty.

​
results
object[]