Parameters for price create.
Summary
Types
@type currency_options() :: %{ optional(:custom_unit_amount) => currency_options_custom_unit_amount() | nil, optional(:tax_behavior) => String.t() | nil, optional(:tiers) => [currency_options_tiers()] | nil, optional(:unit_amount) => integer() | nil, optional(:unit_amount_decimal) => String.t() | nil, optional(String.t()) => term() }
custom_unit_amount- When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.tax_behavior- Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One ofinclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. Possible values:exclusive,inclusive,unspecified.tiers- Each element represents a pricing tier. This parameter requiresbilling_schemeto be set totiered. See also the documentation forbilling_scheme.unit_amount- A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.unit_amount_decimal- Same asunit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set. Format: decimal string.
@type currency_options_custom_unit_amount() :: %{ optional(:enabled) => boolean() | nil, optional(:maximum) => integer() | nil, optional(:minimum) => integer() | nil, optional(:preset) => integer() | nil, optional(String.t()) => term() }
enabled- Pass intrueto enablecustom_unit_amount, otherwise omitcustom_unit_amount.maximum- The maximum unit amount the customer can specify for this item.minimum- The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.preset- The starting unit amount which can be updated by the customer.
@type currency_options_tiers() :: %{ optional(:flat_amount) => integer() | nil, optional(:flat_amount_decimal) => String.t() | nil, optional(:unit_amount) => integer() | nil, optional(:unit_amount_decimal) => String.t() | nil, optional(:up_to) => map() | nil, optional(String.t()) => term() }
flat_amount- The flat billing amount for an entire tier, regardless of the number of units in the tier.flat_amount_decimal- Same asflat_amount, but accepts a decimal value representing an integer in the minor units of the currency. Only one offlat_amountandflat_amount_decimalcan be set. Format: decimal string.unit_amount- The per unit billing amount for each individual unit for which this tier applies.unit_amount_decimal- Same asunit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set. Format: decimal string.up_to- Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Useinfto define a fallback tier.
@type custom_unit_amount() :: %{ optional(:enabled) => boolean() | nil, optional(:maximum) => integer() | nil, optional(:minimum) => integer() | nil, optional(:preset) => integer() | nil, optional(String.t()) => term() }
enabled- Pass intrueto enablecustom_unit_amount, otherwise omitcustom_unit_amount.maximum- The maximum unit amount the customer can specify for this item.minimum- The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.preset- The starting unit amount which can be updated by the customer.
@type product_data() :: %{ optional(:active) => boolean() | nil, optional(:id) => String.t() | nil, optional(:metadata) => %{required(String.t()) => String.t()} | nil, optional(:name) => String.t() | nil, optional(:statement_descriptor) => String.t() | nil, optional(:tax_code) => String.t() | nil, optional(:unit_label) => String.t() | nil, optional(String.t()) => term() }
active- Whether the product is currently available for purchase. Defaults totrue.id- The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated. Max length: 5000.metadata- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value tometadata.name- The product's name, meant to be displayable to the customer. Max length: 5000.statement_descriptor- An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
This may be up to 22 characters. The statement description may not include ,`, ", ' characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. Max length: 22.
tax_code- A tax code ID. Max length: 5000.unit_label- A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. Max length: 12.
@type recurring() :: %{ optional(:interval) => String.t() | nil, optional(:interval_count) => integer() | nil, optional(:meter) => String.t() | nil, optional(:trial_period_days) => integer() | nil, optional(:usage_type) => String.t() | nil, optional(String.t()) => term() }
interval- Specifies billing frequency. Eitherday,week,monthoryear. Possible values:day,month,week,year.interval_count- The number of intervals between subscription billings. For example,interval=monthandinterval_count=3bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).meter- The meter tracking the usage of a metered price Max length: 5000.trial_period_days- Default number of trial days when subscribing a customer to this price usingtrial_from_plan=true.usage_type- Configures how the quantity per period should be determined. Can be eithermeteredorlicensed.licensedautomatically bills thequantityset when adding it to a subscription.meteredaggregates the total usage based on usage records. Defaults tolicensed. Possible values:licensed,metered.
@type t() :: %Stripe.Params.PriceCreateParams{ active: boolean() | nil, billing_scheme: String.t() | nil, currency: String.t(), currency_options: %{required(String.t()) => currency_options()} | nil, custom_unit_amount: custom_unit_amount() | nil, expand: [String.t()] | nil, lookup_key: String.t() | nil, metadata: %{required(String.t()) => String.t()} | nil, nickname: String.t() | nil, product: String.t() | nil, product_data: product_data() | nil, recurring: recurring() | nil, tax_behavior: String.t() | nil, tiers: [tiers()] | nil, tiers_mode: String.t() | nil, transfer_lookup_key: boolean() | nil, transform_quantity: transform_quantity() | nil, unit_amount: integer() | nil, unit_amount_decimal: String.t() | nil }
active- Whether the price can be used for new purchases. Defaults totrue.billing_scheme- Describes how to compute the price per period. Eitherper_unitortiered.per_unitindicates that the fixed amount (specified inunit_amountorunit_amount_decimal) will be charged per unit inquantity(for prices withusage_type=licensed), or per unit of total usage (for prices withusage_type=metered).tieredindicates that the unit pricing will be computed using a tiering strategy as defined using thetiersandtiers_modeattributes. Possible values:per_unit,tiered.currency- Three-letter ISO currency code, in lowercase. Must be a supported currency. Format: ISO 4217 currency code.currency_options- Prices defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.custom_unit_amount- When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.expand- Specifies which fields in the response should be expanded.lookup_key- A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. Max length: 200.metadata- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value tometadata.nickname- A brief description of the price, hidden from customers. Max length: 5000.product- The ID of the Product that this Price will belong to. Max length: 5000.product_data- These fields can be used to create a new product that this price will belong to.recurring- The recurring components of a price such asintervalandusage_type.tax_behavior- Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One ofinclusive,exclusive, orunspecified. Once specified as eitherinclusiveorexclusive, it cannot be changed. Possible values:exclusive,inclusive,unspecified.tiers- Each element represents a pricing tier. This parameter requiresbilling_schemeto be set totiered. See also the documentation forbilling_scheme.tiers_mode- Defines if the tiering price should begraduatedorvolumebased. Involume-based tiering, the maximum quantity within a period determines the per unit price, ingraduatedtiering pricing can successively change as the quantity grows. Possible values:graduated,volume.transfer_lookup_key- If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.transform_quantity- Apply a transformation to the reported usage or set quantity before computing the billed price. Cannot be combined withtiers.unit_amount- A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One ofunit_amount,unit_amount_decimal, orcustom_unit_amountis required, unlessbilling_scheme=tiered.unit_amount_decimal- Same asunit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set. Format: decimal string.
@type tiers() :: %{ optional(:flat_amount) => integer() | nil, optional(:flat_amount_decimal) => String.t() | nil, optional(:unit_amount) => integer() | nil, optional(:unit_amount_decimal) => String.t() | nil, optional(:up_to) => map() | nil, optional(String.t()) => term() }
flat_amount- The flat billing amount for an entire tier, regardless of the number of units in the tier.flat_amount_decimal- Same asflat_amount, but accepts a decimal value representing an integer in the minor units of the currency. Only one offlat_amountandflat_amount_decimalcan be set. Format: decimal string.unit_amount- The per unit billing amount for each individual unit for which this tier applies.unit_amount_decimal- Same asunit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one ofunit_amountandunit_amount_decimalcan be set. Format: decimal string.up_to- Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Useinfto define a fallback tier.
@type transform_quantity() :: %{ optional(:divide_by) => integer() | nil, optional(:round) => String.t() | nil, optional(String.t()) => term() }
divide_by- Divide usage by this number.round- After division, either round the resultupordown. Possible values:down,up.