Search documentation of stripe_elixir

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

Copy Markdown View Source

Parameters for invoice line item update.

## Summary

### Types

t()

## Types

# t()

    @type t() :: %StripeElixir.Params.InvoiceLineItemUpdateParams{
      amount: integer() | nil,
      description: String.t() | nil,
      discountable: boolean() | nil,
      discounts: map() | nil,
      expand: [String.t()] | nil,
      metadata: map() | nil,
      period: map() | nil,
      price_data: map() | nil,
      pricing: map() | nil,
      quantity: integer() | nil,
      tax_amounts: map() | nil,
      tax_rates: map() | nil
    }

- `amount` - The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.
- `description` - An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking. Max length: 5000.
- `discountable` - Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.
- `discounts` - The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts.
- `expand` - Specifies which fields in the response should be expanded.
- `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`. For type=subscription line items, the incoming metadata specified on the request is directly used to set this value, in contrast to type=invoiceitem line items, where any existing metadata on the invoice line is merged with the incoming data.
- `period` - 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.
- `price_data` - Data used to generate a new Price object inline.
- `pricing` - The pricing information for the invoice item.
- `quantity` - Non-negative integer. The quantity of units for the line item.
- `tax_amounts` - A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has tax_rates or if the invoice has default_tax_rates or uses automatic tax. Pass an empty string to remove previously defined tax amounts.
- `tax_rates` - The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates.