PolarExpress.Schemas.DiscountFixedRepeatDuration (polar_express v0.2.2)

Copy Markdown View Source

DiscountFixedRepeatDuration

Schema for a fixed amount discount that is applied on every invoice for a certain number of months.

Summary

Types

t()

Functions

schema_name()

Types

t()

@type t() :: %PolarExpress.Schemas.DiscountFixedRepeatDuration{
  amount: term(),
  amounts: term(),
  code: term(),
  created_at: term(),
  currency: term(),
  duration: term(),
  duration_in_months: term(),
  ends_at: term(),
  id: term(),
  max_redemptions: term(),
  metadata: term(),
  modified_at: term(),
  name: term(),
  organization_id: term(),
  products: term(),
  redemptions_count: term(),
  starts_at: term(),
  type: term()
}
  • amount - Deprecated.
  • amounts - Map of currency to fixed amount to discount from the total.
  • code - Code customers can use to apply the discount during checkout. Nullable.
  • created_at - Creation timestamp of the object. Format: date-time.
  • currency - Deprecated.
  • duration
  • duration_in_months
  • ends_at - Timestamp after which the discount is no longer redeemable. Nullable.
  • id - The ID of the object. Format: uuid4.
  • max_redemptions - Maximum number of times the discount can be redeemed. Nullable.
  • metadata
  • modified_at - Last modification timestamp of the object. Nullable.
  • name - Name of the discount. Will be displayed to the customer when the discount is applied.
  • organization_id - The organization ID. Format: uuid4.
  • products
  • redemptions_count - Number of times the discount has been redeemed.
  • starts_at - Timestamp after which the discount is redeemable. Nullable.
  • type

Functions

schema_name()