Customers

Customer API Docs

Endpoint

https://api.payload.co/customers

Nested Objects

https://api.payload.co/customers/{id}/payment_methods

Example

{
  "id": "acct_Bun5KJlieTkTdsQpot7xMXWD",
  "object": "customer",
  "attrs": {},
  "created_at": "2021-07-07 23:19:32",
  "description": "string",
  "email": "email@address.com",
  "keep_active": false,
  "modified_at": "2021-07-07 23:19:32",
  "name": "string",
  "payment_methods": [],
  "phone_number": "(123) 456-7890",
  "primary_processing_id": "acct_1lvwrZKI1MwnagUEW8gAubuzN"
}
Attributes Description
id
string readonly
Object ID
object
string readonly
Value: customer
attrs
json
Custom object attributes
created_at
datetime readonly
Timestamp object was created
description
string
Optional description of the account
email
email required
Email address for the account
keep_active
bool readonly: update
Set to false for one-time customers that will not be ongoing
modified_at
datetime readonly
Timestamp object was last updated
name
string required
Name for the account, either a person or company name
payment_methods
list
Array of associated Payment Method objects
phone_number
phone
Phone number for the account
primary_processing_id
id
Specify the primary processing account for a customer