Properties
Name | Type | Required | Description |
---|---|---|---|
currency | str | ✅ | Three-letter ISO 4217 code for the currency used in the amount field. |
customer | str | ✅ | ID of the customer. String starting with cus_. |
amount | float | ❌ | The amount of the total charge or credit for this item. Decimal, including the correct number of decimal places for the currency exponent, as defined in ISO 2417:2015.<BR> This is quantity times unit_amount . A credit is indicated by a negative number. |
description | str | ❌ | Description of the invoice item. |
discountable | bool | ❌ | Determines whether this invoice item is subject to the discount defined in the coupon that is assigned to the customer or subscription.<BR> For negative amounts and prorations, the default is false, and for all other invoice items, the default is true. |
invoice | str | ❌ | ID of the invoice that this invoice item is assigned to. Relevant when subscription is not set. |
metadata | dict | ❌ | A JSON object defined by the client. |
quantity | float | ❌ | Indicates the number of units charged as a single invoice item. Integer. |
subscription | str | ❌ | ID of the subscription to assign this invoice item to. By default, the invoice item is assigned to the customer's subscription whose current billing cycle ends first. Relevant when invoice is not set. |
unit_amount | float | ❌ | Per-unit price of the product or service, adjusted as defined in the plan. Decimal. |