Customer object

{
 "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": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "key": "department",
      "value": "sales",
      "dimension_display_name": "Department",
      "value_display_name": "Sales Team",
      "dimension_id": "d1e2f3a4-b5c6-7890-abcd-ef1234567890",
      "definition_id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
      "created_at": "2024-02-27T02:16:40.389772Z",
      "updated_at": "2024-02-27T02:16:40.389772Z",
      "deleted_at": null,
      "archived_at": null
    }
  ]
 }
}

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

string

required

Unique identifier for the customer.

string

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

string

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

string

Name of the company customer.

string

Email address of the customer.

string

Mobile phone number of the customer.

string

Office phone number of the customer.

string

Full address of the customer.

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.

Array of Tags

Show Tag properties

string

required

The tag’s key

string

required

The tag’s value

ISO8601 timestamp

required

When the tag was created

ISO8601 timestamp

required

When the tag was last updated

ISO8601 timestamp

When the tag was deleted

string

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

object

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

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": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "key": "department",
      "value": "sales",
      "dimension_display_name": "Department",
      "value_display_name": "Sales Team",
      "dimension_id": "d1e2f3a4-b5c6-7890-abcd-ef1234567890",
      "definition_id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
      "created_at": "2024-02-27T02:16:40.389772Z",
      "updated_at": "2024-02-27T02:16:40.389772Z",
      "deleted_at": null,
      "archived_at": null
    }
  ]
 }
}

⌘I

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Integrations

Customer object

Attributes

​Attributes

Attributes