Search documentation of stripe_elixir

# StripeElixir.Params.PriceCreateParams (stripe_elixir v0.1.0)

Copy Markdown View Source

Parameters for price create.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %StripeElixir.Params.PriceCreateParams{
      active: boolean() | nil,
      billing_scheme: String.t() | nil,
      currency: String.t(),
      currency_options: map() | nil,
      custom_unit_amount: map() | nil,
      expand: [String.t()] | nil,
      lookup_key: String.t() | nil,
      metadata: map() | nil,
      nickname: String.t() | nil,
      product: String.t() | nil,
      product_data: map() | nil,
      recurring: map() | nil,
      tax_behavior: String.t() | nil,
      tiers: [map()] | nil,
      tiers_mode: String.t() | nil,
      transfer_lookup_key: boolean() | nil,
      transform_quantity: map() | nil,
      unit_amount: integer() | nil,
      unit_amount_decimal: String.t() | nil
    }

- `active` - Whether the price can be used for new purchases. Defaults to `true`.
- `billing_scheme` - Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes. 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 to `metadata`.
- `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 as `interval` and `usage_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 of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed. Possible values: `exclusive`, `inclusive`, `unspecified`.
- `tiers` - Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
- `tiers_mode` - Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering 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 with `tiers`.
- `unit_amount` - A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`.
- `unit_amount_decimal` - Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set. Format: decimal string.