PolarExpress.Schemas.ProductPriceCustomCreate (polar_express v0.2.0)

ProductPriceCustomCreate

Schema to create a pay-what-you-want price.

Summary

Types

t()

Functions

schema_name()

Types

t()

@type t() :: %PolarExpress.Schemas.ProductPriceCustomCreate{
  amount_type: String.t() | nil,
  maximum_amount: integer() | nil,
  minimum_amount: integer() | nil,
  preset_amount: integer() | nil,
  price_currency: PolarExpress.Schemas.PresentmentCurrency.t() | nil,
  tax_behavior: PolarExpress.Schemas.TaxBehaviorOption.t() | nil
}

amount_type
maximum_amount - The maximum amount the customer can pay. Nullable.
minimum_amount - The minimum amount the customer can pay. If set to 0, the price is 'free or pay what you want' and $0 is accepted. If set to a value between 1-49, it will be rejected. Defaults to 50 cents.
preset_amount - The initial amount shown to the customer. If 0, the customer will see $0 as the default. Values between 1-49 are rejected. Nullable.
price_currency - The currency in which the customer will be charged.
tax_behavior - The tax behavior of the price. If not set, it will default to the organization's default tax behavior. Nullable.