Customers API V4

Create and manage customer records

Create a customer

post

Creates a new customer object. Customer records can be associated with payments for easier tracking.

Authorizations

bearerAuth

AuthorizationstringRequired

API key authentication. Include your API key in the Authorization header as a Bearer token. Example: Authorization: Bearer sk_test_1a2b3c4d5e6f

Body

application/json

emailstring · emailRequired

Customer's email address

Example: [e-mail]

namestringOptional

Customer's full name

Example: John Doe

phonestringOptional

Customer's phone number

Example: [phone]

Responses

200

Customer created successfully

application/json

idstringOptional

Unique identifier for the customer

Example: cus_1a2b3c4d5e6f

emailstring · emailOptional

Customer's email address

Example: [e-mail]

namestring · nullableOptional

Customer's full name

Example: John Doe

phonestring · nullableOptional

Customer's phone number

Example: [phone]

created_atstring · date-timeOptional

Timestamp when the customer was created

Example: 2024-03-15T10:30:00Z

400

Invalid request parameters

application/json

401

Authentication failed

application/json

500

Internal server error

application/json

post

/customers

HTTPcURLJavaScriptPython

POST /v1/customers HTTP/1.1
Host: api.evolvepayments.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "email": "[e-mail]",
  "name": "John Doe",
  "phone": "[phone]",
  "metadata": {
    "account_type": "premium",
    "signup_source": "website"
  }
}

{
  "id": "cus_1a2b3c4d5e6f",
  "email": "[e-mail]",
  "name": "John Doe",
  "phone": "[phone]",
  "created_at": "2024-03-15T10:30:00Z",
  "metadata": {
    "account_type": "premium",
    "signup_source": "website"
  }
}

Retrieve a customer

get

Retrieves the details of an existing customer.

Authorizations

bearerAuth

AuthorizationstringRequired

API key authentication. Include your API key in the Authorization header as a Bearer token. Example: Authorization: Bearer sk_test_1a2b3c4d5e6f

Path parameters

idstringRequired

The customer ID

Example: cus_1a2b3c4d5e6f

Responses

200

Customer retrieved successfully

application/json

idstringOptional

Unique identifier for the customer

Example: cus_1a2b3c4d5e6f

emailstring · emailOptional

Customer's email address

Example: [e-mail]

namestring · nullableOptional

Customer's full name

Example: John Doe

phonestring · nullableOptional

Customer's phone number

Example: [phone]

created_atstring · date-timeOptional

Timestamp when the customer was created

Example: 2024-03-15T10:30:00Z

401

Authentication failed

application/json

404

Customer not found

application/json

500

Internal server error

application/json

get

/customers/{id}

HTTPcURLJavaScriptPython

GET /v1/customers/{id} HTTP/1.1
Host: api.evolvepayments.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "cus_1a2b3c4d5e6f",
  "email": "[e-mail]",
  "name": "John Doe",
  "phone": "[phone]",
  "created_at": "2024-03-15T10:30:00Z",
  "metadata": {
    "account_type": "premium",
    "signup_source": "website"
  }
}