Customers

https://api.payload.com/customers

Nested Objects

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

https://api.payload.com/customers/{id}/primary_processing

Example

{
  "id": "acct_QLORDy96Z24vetDOiwvQfyGX",
  "object": "customer",
  "attrs": {},
  "created_at": "2024-08-21 13:35:03",
  "description": "string",
  "email": "[email protected]",
  "external_uid": "string",
  "keep_active": false,
  "modified_at": "2024-08-21 13:35:03",
  "name": "string",
  "payment_methods": [],
  "phone_number": "(123) 456-7890",
  "primary_processing_id": "acct_p0nIuFCPOsygOigB4pae7NXf"
}

Attributes	Description
`id` string readonly	Object ID
`object` string readonly	Value: customer
`attrs` json	Custom object attributes
`created_at` datetime readonly	None
`description` string	Optional description of the account
`email` email required	Email address for the account
`external_uid` string	Optional unique external id used for lookup and upsert
`keep_active` bool readonly: update	Set to false for one-time customers that will not be ongoing
`modified_at` datetime readonly	None
`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