# `Stripe.Resources.Price`
[🔗](https://github.com/jeffhuen/tiger_stripe/blob/main/lib/stripe/resources/price.ex#L2)

Price

Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.
[Products](https://api.stripe.com#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.

For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.

Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription), [create an invoice](https://docs.stripe.com/billing/invoices/create), and more about [products and prices](https://docs.stripe.com/products-prices/overview).

# `currency_options`

```elixir
@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. Nullable.
* `tax_behavior` - Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) 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`. Nullable.
* `tiers` - Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
* `unit_amount` - The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. Nullable.
* `unit_amount_decimal` - The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. Format: decimal string. Nullable.

# `currency_options_custom_unit_amount`

```elixir
@type currency_options_custom_unit_amount() :: %{
  optional(:maximum) => integer() | nil,
  optional(:minimum) => integer() | nil,
  optional(:preset) => integer() | nil,
  optional(String.t()) => term()
}
```

* `maximum` - The maximum unit amount the customer can specify for this item. Nullable.
* `minimum` - The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. Nullable.
* `preset` - The starting unit amount which can be updated by the customer. Nullable.

# `currency_options_tiers`

```elixir
@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) => integer() | nil,
  optional(String.t()) => term()
}
```

* `flat_amount` - Price for the entire tier. Nullable.
* `flat_amount_decimal` - Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. Format: decimal string. Nullable.
* `unit_amount` - Per unit price for units relevant to the tier. Nullable.
* `unit_amount_decimal` - Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. Format: decimal string. Nullable.
* `up_to` - Up to and including to this quantity will be contained in the tier. Nullable.

# `custom_unit_amount`

```elixir
@type custom_unit_amount() :: %{
  optional(:maximum) => integer() | nil,
  optional(:minimum) => integer() | nil,
  optional(:preset) => integer() | nil,
  optional(String.t()) => term()
}
```

* `maximum` - The maximum unit amount the customer can specify for this item. Nullable.
* `minimum` - The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount. Nullable.
* `preset` - The starting unit amount which can be updated by the customer. Nullable.

# `recurring`

```elixir
@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` - The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`. Possible values: `day`, `month`, `week`, `year`.
* `interval_count` - The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months.
* `meter` - The meter tracking the usage of a metered price Max length: 5000. Nullable.
* `trial_period_days` - Default number of trial days when subscribing a customer to this price using [`trial_from_plan=true`](https://docs.stripe.com/api#create_subscription-trial_from_plan). Nullable.
* `usage_type` - Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. Possible values: `licensed`, `metered`.

# `t`

```elixir
@type t() :: %Stripe.Resources.Price{
  active: boolean(),
  billing_scheme: String.t(),
  created: integer(),
  currency: String.t(),
  currency_options: %{required(String.t()) => currency_options()} | nil,
  custom_unit_amount: custom_unit_amount(),
  id: String.t(),
  livemode: boolean(),
  lookup_key: String.t(),
  metadata: %{required(String.t()) => String.t()},
  nickname: String.t(),
  object: String.t(),
  product: String.t() | Stripe.Resources.Product.t(),
  recurring: recurring(),
  tax_behavior: String.t(),
  tiers: [tiers()] | nil,
  tiers_mode: String.t(),
  transform_quantity: transform_quantity(),
  type: String.t(),
  unit_amount: integer(),
  unit_amount_decimal: String.t()
}
```

* `active` - Whether the price can be used for new purchases.
* `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`.
* `created` - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
* `currency` - Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: ISO 4217 currency code.
* `currency_options` - Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). Expandable.
* `custom_unit_amount` - When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links. Nullable. Expandable.
* `id` - Unique identifier for the object. Max length: 5000.
* `livemode` - Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
* `lookup_key` - A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters. Max length: 5000. Nullable.
* `metadata` - Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
* `nickname` - A brief description of the price, hidden from customers. Max length: 5000. Nullable.
* `object` - String representing the object's type. Objects of the same type share the same value. Possible values: `price`.
* `product` - The ID of the product this price is associated with. Expandable.
* `recurring` - The recurring components of a price such as `interval` and `usage_type`. Nullable. Expandable.
* `tax_behavior` - Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) 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`. Nullable.
* `tiers` - Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`. Expandable.
* `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 change as the quantity grows. Possible values: `graduated`, `volume`. Nullable.
* `transform_quantity` - Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`. Nullable. Expandable.
* `type` - One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase. Possible values: `one_time`, `recurring`.
* `unit_amount` - The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`. Nullable.
* `unit_amount_decimal` - The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`. Format: decimal string. Nullable.

# `tiers`

```elixir
@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) => integer() | nil,
  optional(String.t()) => term()
}
```

* `flat_amount` - Price for the entire tier. Nullable.
* `flat_amount_decimal` - Same as `flat_amount`, but contains a decimal value with at most 12 decimal places. Format: decimal string. Nullable.
* `unit_amount` - Per unit price for units relevant to the tier. Nullable.
* `unit_amount_decimal` - Same as `unit_amount`, but contains a decimal value with at most 12 decimal places. Format: decimal string. Nullable.
* `up_to` - Up to and including to this quantity will be contained in the tier. Nullable.

# `transform_quantity`

```elixir
@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 result `up` or `down`. Possible values: `down`, `up`.

# `expandable_fields`

# `object_name`

---

*Consult [api-reference.md](api-reference.md) for complete listing*