PolarExpress.Schemas.DiscountFixedRepeatDurationCreate
(polar_express v0.2.2)
Copy Markdown
View Source
DiscountFixedRepeatDurationCreate
Schema to create a fixed amount discount that is applied on every invoice for a certain number of months.
Summary
Types
@type t() :: %PolarExpress.Schemas.DiscountFixedRepeatDurationCreate{ amount: term(), amounts: term(), code: term(), currency: term(), duration: term(), duration_in_months: term(), ends_at: term(), max_redemptions: term(), metadata: term(), name: term(), organization_id: term(), products: term(), starts_at: term(), type: term() }
amount- Nullable. Deprecated.amounts- Nullable.code- Code customers can use to apply the discount during checkout. Must be between 3 and 256 characters long and contain only alphanumeric characters.If not provided, the discount can only be applied via the API. Nullable.currency- Nullable. Deprecated.durationduration_in_months- Number of months the discount should be applied.
For this to work on yearly pricing, you should multiply this by 12. For example, to apply the discount for 2 years, set this to 24.
ends_at- Optional timestamp after which the discount is no longer redeemable. Nullable.max_redemptions- Optional maximum number of times the discount can be redeemed. Nullable.metadata- Key-value object allowing you to store additional information.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
name- Name of the discount. Will be displayed to the customer when the discount is applied.organization_id- The ID of the organization owning the discount. Required unless you use an organization token. Nullable.products- Nullable.starts_at- Optional timestamp after which the discount is redeemable. Nullable.type- Type of the discount.