A customer in an organization.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
str | ✔️ | The ID of the customer. | 992fae2a-2a17-4b7a-8d9e-e287cf90131b |
created_at |
date | ✔️ | Creation timestamp of the object. | |
modified_at |
date | ✔️ | Last modification timestamp of the object. | |
metadata |
Dict[str, models.MetadataOutputType] | ✔️ | N/A | |
external_id |
OptionalNullable[str] | ➖ | 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 |
str | ✔️ | The email address of the customer. This must be unique within the organization. | customer@example.com |
email_verified |
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 |
type |
OptionalNullable[models.CustomerType] | ➖ | The type of customer: 'individual' for single users, 'team' for customers with multiple members. Legacy customers may have NULL type which is treated as 'individual'. | individual |
name |
Nullable[str] | ✔️ | The name of the customer. | John Doe |
billing_address |
Nullable[models.Address] | ✔️ | N/A | |
tax_id |
List[Nullable[models.CustomerTaxID]] | ✔️ | N/A | [ "911144442", "us_ein" ] |
locale |
OptionalNullable[str] | ➖ | N/A | |
organization_id |
str | ✔️ | The ID of the organization owning the customer. | 1dbfc517-0bbf-4301-9ba8-555ca42b9737 |
deleted_at |
date | ✔️ | Timestamp for when the customer was soft deleted. | |
avatar_url |
str | ✔️ | N/A | https://www.gravatar.com/avatar/xxx?d=404 |