A customer in an organization.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
ID |
string | ✔️ | The ID of the customer. | 992fae2a-2a17-4b7a-8d9e-e287cf90131b |
CreatedAt |
time.Time | ✔️ | Creation timestamp of the object. | |
ModifiedAt |
time.Time | ✔️ | Last modification timestamp of the object. | |
Metadata |
map[string]components.CustomerMetadata1 | ✔️ | 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 |
[]components.CustomerTaxID | ✔️ | N/A | [ "911144442", "us_ein" ] |
OrganizationID |
string | ✔️ | The ID of the organization owning the customer. | 1dbfc517-0bbf-4301-9ba8-555ca42b9737 |
DeletedAt |
time.Time | ✔️ | Timestamp for when the customer was soft deleted. | |
AvatarURL |
string | ✔️ | N/A | https://www.gravatar.com/avatar/xxx?d=blank |