Customers
Customers API operations.
Summary
Types
@type t() :: %PolarExpress.Resources.Customers{ active_meters: [map()] | nil, active_subscriptions: [map()] | nil, avatar_url: String.t() | nil, billing_address: term() | nil, created_at: String.t() | nil, deleted_at: term() | nil, email: String.t() | nil, email_verified: boolean() | nil, external_id: term() | nil, granted_benefits: [map()] | nil, id: String.t() | nil, locale: term() | nil, metadata: map() | nil, modified_at: term() | nil, name: term() | nil, organization_id: String.t() | nil, tax_id: term() | nil, type: term() | nil }
active_meters- The customer's active meters.active_subscriptions- The customer's active subscriptions.avatar_urlbilling_addresscreated_at- Creation timestamp of the object. Format: date-time.deleted_at- Timestamp for when the customer was soft deleted.email- The email address of the customer. This must be unique within the organization.email_verified- Whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address.external_id- The ID of the customer in your system. This must be unique within the organization. Once set, it can't be updated.granted_benefits- The customer's active benefit grants.id- The ID of the customer. Format: uuid4.localemetadatamodified_at- Last modification timestamp of the object.name- The name of the customer.organization_id- The ID of the organization owning the customer. Format: uuid4.tax_idtype- 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'.