@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 product_data() :: %{
  optional(:description) => binary(),
  optional(:images) => [binary()],
  optional(:metadata) => %{optional(binary()) => binary()},
  optional(:name) => binary(),
  optional(:tax_code) => binary()
}

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

@type t() :: %Stripe.LineItem{
  amount: integer(),
  amount_excluding_tax: integer() | nil,
  currency: binary(),
  description: binary() | nil,
  discount_amounts: term() | nil,
  discountable: boolean(),
  discounts: term() | nil,
  id: binary(),
  invoice_item: binary() | Stripe.Invoiceitem.t(),
  livemode: boolean(),
  metadata: term(),
  object: binary(),
  period: term(),
  plan: Stripe.Plan.t() | nil,
  price: Stripe.Price.t() | nil,
  proration: boolean(),
  proration_details: term() | nil,
  quantity: integer() | nil,
  subscription: (binary() | Stripe.Subscription.t()) | nil,
  subscription_item: binary() | Stripe.SubscriptionItem.t(),
  tax_amounts: term(),
  tax_rates: term(),
  type: binary(),
  unit_amount_excluding_tax: binary() | nil
}

The line_item type.

• amount The amount, in cents (or local equivalent).
• amount_excluding_tax The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts.
• 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_item The ID of the invoice item associated with this line item if any.
• 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 this will reflect the metadata of the subscription that caused the line item to be created.
• object String representing the object's type. Objects of the same type share the same value.
• period
• plan The plan of the subscription, if the line item is a subscription or a proration.
• price The price of the line item.
• proration Whether this is a proration.
• proration_details Additional details for proration line items
• quantity The quantity of the subscription, if the line item is a subscription or a proration.
• subscription The subscription that the invoice item pertains to, if any.
• subscription_item The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription.
• tax_amounts The amount of tax calculated per tax rate for this line item
• tax_rates The tax rates which apply to the line item.
• type A string identifying the type of the source of this line item, either an invoiceitem or a subscription.
• unit_amount_excluding_tax The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts.

@type tax_rate_data() :: %{
  optional(:country) => binary(),
  optional(:description) => binary(),
  optional(:display_name) => binary(),
  optional(:inclusive) => boolean(),
  optional(:jurisdiction) => binary(),
  optional(:percentage) => number(),
  optional(:state) => binary(),
  optional(:tax_type) =>
    :amusement_tax
    | :communications_tax
    | :gst
    | :hst
    | :igst
    | :jct
    | :lease_tax
    | :pst
    | :qst
    | :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.