The Invoice Line Item object 

Attributes

• idstring

  Unique identifier for the object.

• amountinteger

  The amount, in cents.

• currencyenum

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

• descriptionnullable string

  An arbitrary string attached to the object. Often useful for displaying to users.

• invoicenullable string

  The ID of the invoice that contains this line item.

• metadataobject

  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.

• parentnullable object

  The parent that generated this line item.

  Hide child attributes

  • parent.invoice_item_detailsnullable object

    Details about the invoice item that generated this line item

    Hide child attributes

    • parent.invoice_item_details.invoice_itemstring

      The invoice item that generated this line item

    • parent.invoice_item_details.prorationboolean

      Whether this is a proration

    • parent.invoice_item_details.proration_detailsnullable object

      Additional details for proration line items

      Hide child attributes

      • parent.invoice_item_details.proration_details.credited_itemsnullable object

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

        Hide child attributes

        • parent.invoice_item_details.proration_details.credited_items.invoicestring

          Invoice containing the credited invoice line items

        • parent.invoice_item_details.proration_details.credited_items.invoice_line_itemsarray of strings

          Credited invoice line items

    • parent.invoice_item_details.subscriptionnullable string

      The subscription that the invoice item belongs to

  • parent.subscription_item_detailsnullable object

    Details about the subscription item that generated this line item

    Hide child attributes

    • parent.subscription_item_details.invoice_itemnullable string

      The invoice item that generated this line item

    • parent.subscription_item_details.prorationboolean

      Whether this is a proration

    • parent.subscription_item_details.proration_detailsnullable object

      Additional details for proration line items

      Hide child attributes

      • parent.subscription_item_details.proration_details.credited_itemsnullable object

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

        Hide child attributes

        • parent.subscription_item_details.proration_details.credited_items.invoicestring

          Invoice containing the credited invoice line items

        • parent.subscription_item_details.proration_details.credited_items.invoice_line_itemsarray of strings

          Credited invoice line items

    • parent.subscription_item_details.subscriptionnullable string

      The subscription that the subscription item belongs to

    • parent.subscription_item_details.subscription_itemstring

      The subscription item that generated this line item

  • parent.typeenum

    The type of parent that generated this line item

    Possible enum values

    invoice_item_details Details of the parent can be found in the invoice_item_details hash.

    subscription_item_details Details of the parent can be found in the subscription_item_details hash.

• periodobject

  The period this line_item covers. For subscription line items, this is the subscription period. For prorations, this starts when the proration was calculated, and ends at the period end of the subscription. For invoice items, this is the time at which the invoice item was created or the period of the item. If you have Stripe Revenue Recognition enabled, the period will be used to recognize and defer revenue. See the Revenue Recognition documentation for details.

  Hide child attributes

  • period.endtimestamp

    The end of the period, which must be greater than or equal to the start. This value is inclusive.

  • period.starttimestamp

    The start of the period. This value is inclusive.

• pricingnullable object

  The pricing information of the line item.

  Hide child attributes

  • pricing.price_detailsnullable object

    Additional details about the price this item is associated with. This is present only when the type is price_details

    Hide child attributes

    • pricing.price_details.pricestring

      The ID of the price this item is associated with.

    • pricing.price_details.productstring

      The ID of the product this item is associated with.

  • pricing.typeenum

    The type of the pricing details.

  • pricing.unit_amount_decimalnullable decimal string

    The unit amount (in the currency specified) of the item which contains a decimal value with at most 12 decimal places.

• quantitynullable integer

  The quantity of the subscription, if the line item is a subscription or a proration.

More attributes

Collapse all

• objectstring

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

• discount_amountsnullable array of objects

  The amount of discount calculated per discount for this line item.

  Hide child attributes

  • discount_amounts.amountinteger

    The amount, in cents, of the discount.

  • discount_amounts.discountstringExpandable

    The discount that was applied to get this discount amount.

• discountableboolean

  If true, discounts will apply to this line item. Always false for prorations.

• discountsarray of stringsExpandable

  The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• pretax_credit_amountsnullable array of objects

  Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.

  Hide child attributes

  • pretax_credit_amounts.amountinteger

    The amount, in cents, of the pretax credit amount.

  • pretax_credit_amounts.credit_balance_transactionnullable stringExpandable

    The credit balance transaction that was applied to get this pretax credit amount.

  • pretax_credit_amounts.discountnullable stringExpandable

    The discount that was applied to get this pretax credit amount.

  • pretax_credit_amounts.typeenum

    Type of the pretax credit amount referenced.

    Possible enum values

    credit_balance_transaction The pretax credit amount is from a credit balance transaction.

    discount The pretax credit amount is from a discount.

• taxesnullable array of objects

  The tax information of the line item.

  Hide child attributes

  • taxes.amountinteger

    The amount of the tax, in cents.

  • taxes.tax_behaviorenum

    Whether this tax is inclusive or exclusive.

    Possible enum values

    exclusive

    inclusive

  • taxes.tax_rate_detailsnullable object

    Additional details about the tax rate. Only present when type is tax_rate_details.

  • taxes.taxability_reasonenum

    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.

    Possible enum values

    customer_exempt No tax is applied as the customer is exempt from tax.

    not_available The reasoning behind this tax is not available.

    not_collecting No tax is collected either because you are not registered to collect tax in this jurisdiction, or because the non-taxable product tax code (txcd_00000000) was used.

    not_subject_to_tax No tax is imposed on this transaction.

    not_supported No tax applied. Stripe doesn’t support this jurisdiction, territory, or product.

    portion_product_exempt A portion of the price is exempt from tax.

    portion_reduced_rated A portion of the price is taxed at a reduced rate.

    portion_standard_rated A portion of the price is taxed at the standard rate.

    product_exempt The product or service is nontaxable or exempt from tax.

    product_exempt_holiday The product or service is not taxed due to a sales tax holiday.

    Show 6 more

  • taxes.taxable_amountnullable integer

    The amount on which tax is calculated, in cents.

  • taxes.typeenum

    The type of tax information.