OrderCustomer

June 12, 2026 ยท View on GitHub

Fields

FieldTypeRequiredDescriptionExample
idstr:heavy_check_mark:The ID of the customer.992fae2a-2a17-4b7a-8d9e-e287cf90131b
created_atdate:heavy_check_mark:Creation timestamp of the object.
modified_atdate:heavy_check_mark:Last modification timestamp of the object.
metadataDict[str, models.MetadataOutputType]:heavy_check_mark:N/A
external_idOptionalNullable[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
emailOptionalNullable[str]:heavy_minus_sign:The email address of the customer. This must be unique within the organization.customer@example.com
email_verifiedbool:heavy_check_mark:Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.true
typemodels.CustomerType:heavy_check_mark:N/A
nameNullable[str]:heavy_check_mark:The name of the customer.John Doe
billing_nameNullable[str]:heavy_check_mark:The name that should appear on the customer's invoices. Falls back to the customer name when not explicitly set.John Doe
billing_addressNullable[models.Address]:heavy_check_mark:N/A
tax_idList[Nullable[models.OrderCustomerTaxID]]:heavy_check_mark:N/A[
"911144442",
"us_ein"
]
localeOptionalNullable[str]:heavy_minus_sign:N/A
organization_idstr:heavy_check_mark:The ID of the organization owning the customer.1dbfc517-0bbf-4301-9ba8-555ca42b9737
default_payment_method_idOptionalNullable[str]:heavy_minus_sign:The ID of the customer's default payment method, if any. Use the payment methods endpoint to retrieve its details.
deleted_atdate:heavy_check_mark:Timestamp for when the customer was soft deleted.
avatar_urlstr:heavy_check_mark:N/Ahttps://www.gravatar.com/avatar/xxx?d=404