Amount Breakdown

November 13, 2025 ยท View on GitHub

The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.

Structure

AmountBreakdown

Fields

NameTypeTagsDescriptionGetterSetter
ItemTotalMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getItemTotal()setItemTotal(Money itemTotal)
ShippingMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getShipping()setShipping(Money shipping)
HandlingMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getHandling()setHandling(Money handling)
TaxTotalMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getTaxTotal()setTaxTotal(Money taxTotal)
InsuranceMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getInsurance()setInsurance(Money insurance)
ShippingDiscountMoneyOptionalThe currency and amount for a financial transaction, such as a balance or payment due.Money getShippingDiscount()setShippingDiscount(Money shippingDiscount)
DiscountMoneyOptionalThe discount amount and currency code. For list of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.Money getDiscount()setDiscount(Money discount)

Example (as JSON)

{
  "item_total": {
    "currency_code": "currency_code0",
    "value": "value6"
  },
  "shipping": {
    "currency_code": "currency_code0",
    "value": "value6"
  },
  "handling": {
    "currency_code": "currency_code2",
    "value": "value8"
  },
  "tax_total": {
    "currency_code": "currency_code4",
    "value": "value0"
  },
  "insurance": {
    "currency_code": "currency_code2",
    "value": "value8"
  }
}