Skip to main content
GET
/
customers
/
{id}
Find a customer
curl --request GET \
  --url https://sandbox-api.paynext.com/customers/{id} \
  --header 'Authorization: Bearer <token>'
{
  "object": "customer",
  "id": "cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f",
  "email": "alice.johnson@example.com",
  "external_id": "ext_001",
  "full_name": "Alice Johnson",
  "phone": "+1-555-123-4567",
  "created_at": "2025-05-28T14:00:00Z",
  "updated_at": "2025-05-28T14:05:00Z",
  "metadata": {
    "tier": "premium"
  },
  "address": {
    "city": "San Francisco",
    "country": "US",
    "line1": "123 Market Street",
    "line2": "Suite 400",
    "postal_code": "94105",
    "state": "CA"
  },
  "payment_methods": [
    {
      "type": "CARD",
      "billing_address": {
        "city": "San Francisco",
        "country": "US",
        "line1": "123 Market Street",
        "line2": "Suite 400",
        "postal_code": "94105",
        "state": "CA"
      },
      "details": {
        "bin": "411111",
        "last4": "1111",
        "exp_month": 12,
        "exp_year": 2028,
        "is_network_tokenized": true,
        "number": "4111111111111111",
        "bin_data": {
          "brand": "visa",
          "country": "US",
          "currency_code": "USD",
          "description": "Chase Sapphire Preferred",
          "funding": "credit",
          "issuer": "Chase Bank",
          "type": "consumer"
        }
      }
    },
    {
      "type": "PAYPAL",
      "details": {
        "payer_info": {
          "email": "alice.johnson@example.com",
          "first_name": "Alice",
          "last_name": "Johnson",
          "payer_id": "PAYER12345",
          "tenant": "Tenant"
        },
        "processor_customer_email": "alice.johnson@example.com",
        "processor_customer_id": "cus_pp_1234567890",
        "processor_payment_method_id": "pm_pp_1234567890"
      }
    },
    {
      "type": "VENMO",
      "details": {
        "processor_payment_method_id": "pm_venmo_1234567890"
      }
    },
    {
      "type": "CASHAPP",
      "details": {
        "processor_customer_id": "cus_ca_1234567890",
        "processor_payment_method_id": "pm_ca_1234567890"
      }
    },
    {
      "type": "APPLEPAY",
      "billing_address": {
        "city": "San Francisco",
        "country": "US",
        "line1": "123 Market Street",
        "line2": "Suite 400",
        "postal_code": "94105",
        "state": "CA"
      },
      "details": {
        "token": "ap_token_12345678",
        "token_exp_month": 12,
        "token_exp_year": 2028,
        "token_service_provider": "APPLE"
      }
    },
    {
      "type": "GPAY",
      "billing_address": {
        "city": "San Francisco",
        "country": "US",
        "line1": "123 Market Street",
        "line2": "Suite 400",
        "postal_code": "94105",
        "state": "CA"
      },
      "details": {
        "token": "gp_token_12345678",
        "token_exp_month": 12,
        "token_exp_year": 2028,
        "token_service_provider": "GOOGLE"
      }
    }
  ],
  "subscriptions": [
    {
      "id": "sub_123e4567-e89b-12d3-a456-426614174000",
      "status": "active",
      "created_at": "2025-05-26T10:00:00Z",
      "updated_at": "2025-05-27T10:00:00Z",
      "current_period_start": "2025-05-26T10:00:00Z",
      "current_period_end": "2025-06-26T10:00:00Z",
      "next_billing_date": "2025-06-26T12:00:00Z",
      "past_due": {
        "attempt_count": 0,
        "max_attempts_count": 7
      },
      "plan": {
        "id": "price_1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "name": "Pro Plan",
        "type": "recurring",
        "interval": "months",
        "interval_count": 1,
        "trial_interval": "days",
        "trial_interval_count": 14,
        "price": {
          "amount": 1999,
          "currency": "USD"
        },
        "trial_price": {
          "amount": 0,
          "currency": "USD"
        },
        "tax": {
          "collect_tax": "DEFAULT"
        }
      },
      "metadata": {
        "key": "value"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authentication header of the form api key, where api key is your organization api key.

Headers

​
X-API-Version
enum<string>

Specifies the version of the API to use

Available options:
2.0.0

Path Parameters

​
id
string
required

The ID of the customer to find

Response

Returns the customer object if a valid identifier was provided.

​
id
string

Unique identifier

Example:

"cus_b8d0fe7e-3a7f-4b5f-a68b-d31358b49c3f"

​
address
object

Address associated with customer

​
email
string

Email of the customer

Example:

"alice.johnson@example.com"

​
external_id
string

External ID of the customer

Example:

"ext_001"

​
full_name
string

Full name of the customer

Example:

"Alice Johnson"

​
phone
string

Customer's phone number

Example:

"+1-555-123-4567"

​
payment_methods
(Card API Schema · object | PayPal API Schema · object | Venmo API Schema · object | CashApp API Schema · object | Apple Pay API Schema · object | Google Pay API Schema · object)[]

Customer's saved payment methods.

​
subscriptions
object[]

Customer's subscriptions with plan details.

​
metadata
object

Additional metadata as a JSON object

Example:
{ "key": "value" }
​
created_at
string

The date and time the customer was created in UTC format

Example:

"2025-05-28T14:00:00Z"

​
updated_at
string

The date and time the customer was last updated in UTC format

Example:

"2025-05-28T14:05:00Z"