PolarExpress.Schemas.ProductPriceCustom (polar_express v0.2.2)

Copy Markdown View Source

ProductPriceCustom

A pay-what-you-want price for a product.

Summary

Types

t()

@type t() :: %PolarExpress.Schemas.ProductPriceCustom{
  amount_type: term(),
  created_at: term(),
  id: term(),
  is_archived: term(),
  maximum_amount: term(),
  minimum_amount: term(),
  modified_at: term(),
  preset_amount: term(),
  price_currency: term(),
  product_id: term(),
  source: term(),
  tax_behavior: term()
}
  • amount_type
  • created_at - Creation timestamp of the object. Format: date-time.
  • id - The ID of the price. Format: uuid4.
  • is_archived - Whether the price is archived and no longer available.
  • maximum_amount - The maximum amount the customer can pay. Nullable.
  • minimum_amount - The minimum amount the customer can pay. If 0, the price is 'free or pay what you want'. Defaults to 50 cents.
  • modified_at - Last modification timestamp of the object. Nullable.
  • preset_amount - The initial amount shown to the customer. Nullable.
  • price_currency - The currency in which the customer will be charged.
  • product_id - The ID of the product owning the price. Format: uuid4.
  • source - The source of the price . catalog is a predefined price, while ad_hoc is a price created dynamically on a Checkout session.
  • tax_behavior - The tax behavior of the price. If null, it defaults to the organization's default tax behavior. Nullable.

Functions

schema_name()