PayPal · Schema

Amount with Breakdown

The breakdown details for the amount. Includes the gross, tax, fee, and shipping amounts.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
gross_amount object The amount for this transaction.
total_item_amount object The item total for the transaction.
fee_amount object The fee details for the transaction.
shipping_amount object The shipping amount for the transaction.
tax_amount object The tax amount for the transaction.
net_amount object The net amount that the payee receives for this transaction in their PayPal account. The net amount is computed as gross_amount minus the paypal_fee.
View JSON Schema on GitHub

JSON Schema

paypal-amount-with-breakdown-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/amount_with_breakdown",
  "title": "Amount with Breakdown",
  "type": "object",
  "description": "The breakdown details for the amount. Includes the gross, tax, fee, and shipping amounts.",
  "properties": {
    "gross_amount": {
      "description": "The amount for this transaction.",
      "readOnly": true,
      "$ref": "#/components/schemas/money"
    },
    "total_item_amount": {
      "description": "The item total for the transaction.",
      "readOnly": true,
      "$ref": "#/components/schemas/money"
    },
    "fee_amount": {
      "description": "The fee details for the transaction.",
      "readOnly": true,
      "$ref": "#/components/schemas/money"
    },
    "shipping_amount": {
      "description": "The shipping amount for the transaction.",
      "readOnly": true,
      "$ref": "#/components/schemas/money"
    },
    "tax_amount": {
      "description": "The tax amount for the transaction.",
      "readOnly": true,
      "$ref": "#/components/schemas/money"
    },
    "net_amount": {
      "description": "The net amount that the payee receives for this transaction in their PayPal account. The net amount is computed as <code>gross_amount</code> minus the <code>paypal_fee</code>.",
      "readOnly": true,
      "$ref": "#/components/schemas/money"
    }
  },
  "required": [
    "gross_amount"
  ]
}