PolarExpress.Schemas.CustomerStateTeam (polar_express v0.2.2)

Copy Markdown View Source

CustomerStateTeam

A team customer along with additional state information:

  • Active subscriptions
  • Granted benefits
  • Active meters

Summary

Types

t()

Functions

schema_name()

Types

t()

@type t() :: %PolarExpress.Schemas.CustomerStateTeam{
  active_meters: term(),
  active_subscriptions: term(),
  avatar_url: term(),
  billing_address: term(),
  created_at: term(),
  deleted_at: term(),
  email: term(),
  email_verified: term(),
  external_id: term(),
  granted_benefits: term(),
  id: term(),
  locale: term(),
  metadata: term(),
  modified_at: term(),
  name: term(),
  organization_id: term(),
  tax_id: term(),
  type: term()
}
  • active_meters - The customer's active meters.
  • active_subscriptions - The customer's active subscriptions.
  • avatar_url
  • billing_address - Nullable.
  • created_at - Creation timestamp of the object. Format: date-time.
  • deleted_at - Timestamp for when the customer was soft deleted. Nullable.
  • email - The email address of the customer. This must be unique within the organization. Nullable.
  • 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. Nullable.
  • granted_benefits - The customer's active benefit grants.
  • id - The ID of the customer. Format: uuid4.
  • locale - Nullable.
  • metadata
  • modified_at - Last modification timestamp of the object. Nullable.
  • name - The name of the customer. Nullable.
  • organization_id - The ID of the organization owning the customer. Format: uuid4.
  • tax_id - Nullable.
  • type - The type of customer. Team customers can have multiple members.

Functions

schema_name()