View Source Stripe.Item (stripity_stripe v3.2.0)

A line item.

Summary

Types

t()

The item type.

Types

@type t() :: %Stripe.Item{
  amount_discount: integer(),
  amount_subtotal: integer(),
  amount_tax: integer(),
  amount_total: integer(),
  currency: binary(),
  description: binary(),
  discounts: term(),
  id: binary(),
  object: binary(),
  price: Stripe.Price.t() | nil,
  quantity: integer() | nil,
  taxes: term()
}

The item type.

  • amount_discount Total discount amount applied. If no discounts were applied, defaults to 0.
  • amount_subtotal Total before any discounts or taxes are applied.
  • amount_tax Total tax amount applied. If no tax was applied, defaults to 0.
  • amount_total Total after discounts and taxes.
  • currency Three-letter ISO currency code, in lowercase. Must be a supported currency.
  • description An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name.
  • discounts The discounts applied to the line item.
  • id Unique identifier for the object.
  • object String representing the object's type. Objects of the same type share the same value.
  • price The price used to generate the line item.
  • quantity The quantity of products being purchased.
  • taxes The taxes applied to the line item.