PayPal-PHP-Server-SDK/doc/models/amount-with-breakdown.md

Amount With Breakdown

The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any. If you specify amount.breakdown, the amount equals item_total plus tax_total plus shipping plus handling plus insurance minus shipping_discount minus discount. The amount must be a positive number. For listed of supported currencies and decimal precision, see the PayPal REST APIs Currency Codes.

Structure

AmountWithBreakdown

Fields

Name	Type	Tags	Description	Getter	Setter
currencyCode	string	Required	The three-character ISO-4217 currency code that identifies the currency. Constraints: Minimum Length: 3, Maximum Length: 3	getCurrencyCode(): string	setCurrencyCode(string currencyCode): void
value	string	Required	The value, which might be: An integer for currencies like JPY that are not typically fractional. A decimal fraction for currencies like TND that are subdivided into thousandths. For the required number of decimal places for a currency code, see Currency Codes. Constraints: Maximum Length: 32, Pattern: ^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$	getValue(): string	setValue(string value): void
breakdown	?AmountBreakdown	Optional	The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.	getBreakdown(): ?AmountBreakdown	setBreakdown(?AmountBreakdown breakdown): void

Example (as JSON)

{
  "currency_code": "currency_code4",
  "value": "value0",
  "breakdown": {
    "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"
    }
  }
}