On this page
No Headings
The breakdown of the amount. Includes total item amount, total tax amount, custom amount, and shipping and discounts, if any.
objectitem_totalobjectThe subtotal for all items. Must equal the sum of (items[].unit_amount * items[].quantity) for all items.
currency_coderequiredstringThe three-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 at the item or invoice level, 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.
percentstringppaas_common_percentage_v2^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe invoice level discount amount. Value is from 0 to 1000000. Supports up to two decimal places.
currency_coderequiredstringThe three-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 discount as a percent or amount at item level. The item discount amount is subtracted from each item amount.
currency_coderequiredstringThe three-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 aggregated amount of the item and shipping taxes.
currency_coderequiredstringThe three-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 shipping amount. Value is from 0 to 1000000. Supports up to two decimal places.
currency_coderequiredstringThe three-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 associated with the shipping.
namerequiredstring^[\s\S]*$The name of the tax applied on the invoice items.
percentrequiredstringppaas_common_percentage_v2^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The tax rate. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe calculated tax amount. The tax amount is added to the item total.
currency_coderequiredstringThe three-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 the custom amount.
labelrequiredstring^[\S\s]*$The label to the custom amount of the invoice.
amountobjectThe custom amount value. Value is from -1000000 to 1000000. Supports up to two decimal places.
currency_coderequiredstringThe three-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.