@type period() :: %{optional(:end) => integer(), optional(:start) => integer()}

The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have Stripe Revenue Recognition enabled, the period will be used to recognize and defer revenue. See the Revenue Recognition documentation for details.

@type price_data() :: %{
  optional(:currency) => binary(),
  optional(:product) => binary(),
  optional(:product_data) => product_data(),
  optional(:tax_behavior) => :exclusive | :inclusive | :unspecified,
  optional(:unit_amount) => integer(),
  optional(:unit_amount_decimal) => binary()
}

Data used to generate a new Price object inline.

@type pricing() :: %{optional(:price) => binary()}

The pricing information for the invoice item.

@type product_data() :: %{
  optional(:description) => binary(),
  optional(:images) => [binary()],
  optional(:metadata) => %{optional(binary()) => binary()},
  optional(:name) => binary(),
  optional(:tax_code) => binary(),
  optional(:unit_label) => binary()
}

Data used to generate a new Product object inline. One of product or product_data is required.

@type t() :: %Stripe.LineItem{
  amount: integer(),
  currency: binary(),
  description: binary() | nil,
  discount_amounts: term() | nil,
  discountable: boolean(),
  discounts: term(),
  id: binary(),
  invoice: binary() | nil,
  livemode: boolean(),
  metadata: term(),
  object: binary(),
  parent: term() | nil,
  period: term(),
  pretax_credit_amounts: term() | nil,
  pricing: term() | nil,
  quantity: integer() | nil,
  subscription: (binary() | Stripe.Subscription.t()) | nil,
  taxes: term() | nil
}

The line_item type.

• amount The amount, in cents (or local equivalent).
• 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.
• discount_amounts The amount of discount calculated per discount for this line item.
• discountable If true, discounts will apply to this line item. Always false for prorations.
• discounts The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.
• id Unique identifier for the object.
• invoice The ID of the invoice that contains this line item.
• livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
• 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. Note that for line items with type=subscription, metadata reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
• object String representing the object's type. Objects of the same type share the same value.
• parent The parent that generated this line item.
• period
• pretax_credit_amounts Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.
• pricing The pricing information of the line item.
• quantity The quantity of the subscription, if the line item is a subscription or a proration.
• subscription
• taxes The tax information of the line item.

@type tax_rate_data() :: %{
  optional(:country) => binary(),
  optional(:description) => binary(),
  optional(:display_name) => binary(),
  optional(:inclusive) => boolean(),
  optional(:jurisdiction) => binary(),
  optional(:jurisdiction_level) =>
    :city | :country | :county | :district | :multiple | :state,
  optional(:percentage) => number(),
  optional(:state) => binary(),
  optional(:tax_type) =>
    :amusement_tax
    | :communications_tax
    | :gst
    | :hst
    | :igst
    | :jct
    | :lease_tax
    | :pst
    | :qst
    | :retail_delivery_fee
    | :rst
    | :sales_tax
    | :service_tax
    | :vat
}

Data to find or create a TaxRate object.

Stripe automatically creates or reuses a TaxRate object for each tax amount. If the tax_rate_data exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s tax_rates, and cannot be directly added to invoices, payments, or line items.