CustomerUpdate
March 27, 2026 ยท View on GitHub
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
metadata | Dict[str, models.CustomerUpdateMetadata] | :heavy_minus_sign: | Key-value object allowing you to store additional information. The key must be a string with a maximum length of 40 characters. The value must be either: * A string with a maximum length of 500 characters * An integer * A floating-point number * A boolean You can store up to 50 key-value pairs. | |
email | OptionalNullable[str] | :heavy_minus_sign: | The email address of the customer. This must be unique within the organization. | customer@example.com |
name | OptionalNullable[str] | :heavy_minus_sign: | N/A | John Doe |
billing_address | OptionalNullable[models.AddressInput] | :heavy_minus_sign: | N/A | |
tax_id | OptionalNullable[str] | :heavy_minus_sign: | N/A | |
locale | OptionalNullable[str] | :heavy_minus_sign: | N/A | en |
external_id | OptionalNullable[str] | :heavy_minus_sign: | The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated. | usr_1337 |
type | OptionalNullable[models.CustomerType] | :heavy_minus_sign: | The customer type. Can only be upgraded from 'individual' to 'team', never downgraded. |