PayPal · Schema

Invoice Amount Summary

The invoice amount summary of item total, discount, tax total, and shipping.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name	Type	Description
currency_code	object
value	string	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.
breakdown	object	The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, custom amount, shipping and discounts, if any.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/amount_summary_detail",
  "title": "Invoice Amount Summary",
  "type": "object",
  "description": "The invoice amount summary of item total, discount, tax total, and shipping.",
  "properties": {
    "currency_code": {
      "$ref": "#/components/schemas/currency_code"
    },
    "value": {
      "type": "string",
      "description": "The value, which might be:<ul><li>An integer for currencies like `JPY` that are not typically fractional.</li><li>A decimal fraction for currencies like `TND` that are subdivided into thousandths.</li></ul>For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).",
      "maxLength": 32,
      "pattern": "^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$"
    },
    "breakdown": {
      "$ref": "#/components/schemas/amount_with_breakdown",
      "description": "The breakdown of the amount. Breakdown provides details such as total item amount, total tax amount, custom amount, shipping and discounts, if any."
    }
  }
}