PolarExpress.Schemas.CustomerStateSubscription (polar_express v0.2.2)

Copy Markdown View Source

CustomerStateSubscription

An active customer subscription.

Summary

Types

t()

Functions

schema_name()

Types

t()

@type t() :: %PolarExpress.Schemas.CustomerStateSubscription{
  amount: term(),
  cancel_at_period_end: term(),
  canceled_at: term(),
  created_at: term(),
  currency: term(),
  current_period_end: term(),
  current_period_start: term(),
  custom_field_data: term(),
  discount_id: term(),
  ends_at: term(),
  id: term(),
  metadata: term(),
  meters: term(),
  modified_at: term(),
  product_id: term(),
  recurring_interval: term(),
  started_at: term(),
  status: term(),
  trial_end: term(),
  trial_start: term()
}
  • amount - The amount of the subscription.
  • cancel_at_period_end - Whether the subscription will be canceled at the end of the current period.
  • canceled_at - The timestamp when the subscription was canceled. The subscription might still be active if cancel_at_period_end is true. Nullable.
  • created_at - Creation timestamp of the object. Format: date-time.
  • currency - The currency of the subscription.
  • current_period_end - The end timestamp of the current billing period. Format: date-time.
  • current_period_start - The start timestamp of the current billing period. Format: date-time.
  • custom_field_data - Key-value object storing custom field values.
  • discount_id - The ID of the applied discount, if any. Nullable.
  • ends_at - The timestamp when the subscription will end. Nullable.
  • id - The ID of the subscription. Format: uuid4.
  • metadata
  • meters - List of meters associated with the subscription.
  • modified_at - Last modification timestamp of the object. Nullable.
  • product_id - The ID of the subscribed product. Format: uuid4.
  • recurring_interval - The interval at which the subscription recurs.
  • started_at - The timestamp when the subscription started. Nullable.
  • status - Possible values: active, trialing.
  • trial_end - The end timestamp of the trial period, if any. Nullable.
  • trial_start - The start timestamp of the trial period, if any. Nullable.

Functions

schema_name()