{
 "data": {
   "type": "CustomerData",
   "id": "4f7c1b16-e057-4ec0-8b20-50308ba5b9ea",
   "external_id": "customer-1",
   "individual_name": "John Doe",
   "company_name": "Acme, Inc.",
   "email": "john@hotmail.com",
   "mobile_phone": "555-555-5555",
   "office_phone": "555-555-5555",
   "address_string": "123 Main St, Phoenix, AZ 85001",
   "notes": "This is a note",
   "status": "ACTIVE",
   "transaction_tags": [
     {
       "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
       "key": "ExampleTagKey",
       "value": "ExampleTagValue",
       "created_at": "2023-11-07T05:31:56Z",
       "updated_at": "2023-11-07T05:31:56Z",
       "deleted_at": "2023-11-07T05:31:56Z"
     }
   ]
 }
}

A Customer of a business can receive invoices and refunds and have payments applied to their invoices.

Customers can be referenced when creating invoices and refunds using either the Layer id, or the external id.

​
Attributes

​
id
string
required

Unique identifier for the customer.

​
external_id
string

Unique ID of the customer in your system for linking and idempotency.

​
individual_name
string

Full name of the individual customer or contact at a corporate customer.

​
company_name
string

Name of the company customer.

​
email
string

Email address of the customer.

​
mobile_phone
string

Mobile phone number of the customer.

​
office_phone
string

Office phone number of the customer.

​
address_string
string

Full address of the customer.

​
status
enum

Status of the customer. Possible values are: ACTIVE, ARCHIVED Archived customers will not appear when listing customers, but their accounting continues to be tracked and they can still be retrieved directly in the API.

​
transaction_tags
Array of Tags
​
memo
string

Memo for any text you would like to associate with the customer (for example, to display to end users).

​
metadata
object

Arbitrary custom metadata in JSON format with a size limit of 10KB.

​
reference_number
string

Any (typically user-visible) identifier you would like to associate with the customer. Can be used to filter when listing customers.

{
 "data": {
   "type": "CustomerData",
   "id": "4f7c1b16-e057-4ec0-8b20-50308ba5b9ea",
   "external_id": "customer-1",
   "individual_name": "John Doe",
   "company_name": "Acme, Inc.",
   "email": "john@hotmail.com",
   "mobile_phone": "555-555-5555",
   "office_phone": "555-555-5555",
   "address_string": "123 Main St, Phoenix, AZ 85001",
   "notes": "This is a note",
   "status": "ACTIVE",
   "transaction_tags": [
     {
       "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
       "key": "ExampleTagKey",
       "value": "ExampleTagValue",
       "created_at": "2023-11-07T05:31:56Z",
       "updated_at": "2023-11-07T05:31:56Z",
       "deleted_at": "2023-11-07T05:31:56Z"
     }
   ]
 }
}