StripeAPI.Types.LineItem

amount: The amount, in %s.

amount_excluding_tax: The integer amount in %s 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.

Constraints:

• Maximum length of 5000

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.

Constraints:

• Maximum length of 5000

invoice_item: The ID of the invoice item associated with this line item if any.

Constraints:

• Maximum length of 5000

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.

period:

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.

Constraints:

• Maximum length of 5000

subscription_item: The subscription item that generated this invoice item. Left empty if the line item is not an explicit result of a subscription.

Constraints:

• Maximum length of 5000

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 %s representing the unit amount for this line item, excluding all tax and discounts.

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.

created: Time at which the object was created. Measured in seconds since the Unix epoch.

currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.

custom_unit_amount: When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

id: Unique identifier for the object.

Constraints:

• Maximum length of 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.

Constraints:

• Maximum length of 5000

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.

nickname: A brief description of the price, hidden from customers.

Constraints:

• Maximum length of 5000

object: String representing the object's type. Objects of the same type share the same value.

product: The ID of the product this price is associated with.

recurring: The recurring components of a price such as `interval` and `usage_type`.

tax_behavior: 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.

tiers: Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.

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.

transform_quantity: Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`.

type: One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase.

unit_amount: The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.

unit_amount_decimal: The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.

maximum: The maximum unit amount the customer can specify for this item.

minimum: The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.

preset: The starting unit amount which can be updated by the customer.

aggregate_usage: Specifies a usage aggregation strategy for prices of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.

interval: The frequency at which a subscription is billed. One of `day`, `week`, `month` or `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.

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`.

divide_by: Divide usage by this number.

round: After division, either round the result `up` or `down`.

credited_items: For a credit proration `line_item`, the original debit line_items to which the credit proration applies.

invoice: Invoice containing the credited invoice line items

Constraints:

• Maximum length of 5000

invoice_line_items: Credited invoice line items