On this page
No Headings
The invoice amount summary of item total, discount, tax total, and shipping.
objectcurrency_codestring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuestring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.breakdownobjectThe breakdown of the amount. Includes total item amount, total tax amount, custom amount, and shipping and discounts, if any.
item_totalobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The subtotal for all items. Must equal the sum of (items[].unit_amount * items[].quantity) for all items.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.discountobjectThe discount. Can be an item- or invoice-level discount, or both. Can be applied as a percent or amount. If you provide both amount and percent, amount takes precedent.
invoice_discountobjectThe discount as a percent or amount at invoice level. The invoice discount amount is subtracted from the item total.
percentobject^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.
The discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The invoice level discount amount. Value is from 0 to 1000000. Supports up to two decimal places.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.item_discountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The discount as a percent or amount at item level. The item discount amount is subtracted from each item amount.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tax_totalobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The aggregated amount of the item and shipping taxes.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.shippingobjectThe shipping fee for all items. Includes tax on shipping.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The shipping amount. Value is from 0 to 1000000. Supports up to two decimal places.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.taxobjectThe tax information. Includes the tax name and tax rate of invoice items. The tax amount is added to the item total.
The tax associated with the shipping.
namerequiredstring^[\s\S]*$The name of the tax applied on the invoice items.
percentrequiredobject^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.
The tax rate. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The calculated tax amount. The tax amount is added to the item total.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tax_notestring^[\s\S]*$The tax note used to track the tax related data.
customobjectThe custom amount to apply to an invoice. If you include a label, you must include a custom amount.
labelrequiredstring^[\S\s]*$The label to the custom amount of the invoice.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The custom amount value. Value is from -1000000 to 1000000. Supports up to two decimal places.
currency_coderequiredstring^[\S\s]*$The 3-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.