customerstate.md

CustomerState

A customer along with additional state information:

• Active subscriptions
• Granted benefits
• Active meters

Fields

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.CustomerStateMetadata]	✔️	N/A
external_id	Nullable[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
name	Nullable[str]	✔️	The name of the customer.	John Doe
billing_address	Nullable[models.Address]	✔️	N/A
tax_id	List[Nullable[models.CustomerStateTaxID]]	✔️	N/A	[ "911144442", "us_ein" ]
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.
active_subscriptions	List[models.CustomerStateSubscription]	✔️	The customer's active subscriptions.
granted_benefits	List[models.CustomerStateBenefitGrant]	✔️	The customer's active benefit grants.
active_meters	List[models.CustomerStateMeter]	✔️	The customer's active meters.
avatar_url	str	✔️	N/A	https://www.gravatar.com/avatar/xxx?d=blank