A customer in an organization.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
string | ✔️ | The ID of the customer. | 992fae2a-2a17-4b7a-8d9e-e287cf90131b |
createdAt |
\DateTime | ✔️ | Creation timestamp of the object. | |
modifiedAt |
\DateTime | ✔️ | Last modification timestamp of the object. | |
metadata |
array<string, string|int|float|bool> | ✔️ | N/A | |
externalId |
string | ✔️ | The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated. | usr_1337 |
email |
string | ✔️ | The email address of the customer. This must be unique within the organization. | customer@example.com |
emailVerified |
bool | ✔️ | Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address. | true |
name |
string | ✔️ | The name of the customer. | John Doe |
billingAddress |
Components\Address | ✔️ | N/A | |
taxId |
array<string|Components\TaxIDFormat> | ✔️ | N/A | [ "911144442", "us_ein" ] |
organizationId |
string | ✔️ | The ID of the organization owning the customer. | 1dbfc517-0bbf-4301-9ba8-555ca42b9737 |
deletedAt |
\DateTime | ✔️ | Timestamp for when the customer was soft deleted. | |
avatarUrl |
string | ✔️ | N/A | https://www.gravatar.com/avatar/xxx?d=blank |