PayPal · Schema

Tax

The tax information. Includes the tax name and tax rate of invoice items. The tax amount is added to the item total.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
name string The name of the tax applied on the invoice items.
percent object The tax rate. Value is from `0` to `100`. Supports up to five decimal places.
amount object The calculated tax amount. The tax amount is added to the item total.
View JSON Schema on GitHub

JSON Schema

paypal-tax-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/tax",
  "title": "Tax",
  "type": "object",
  "description": "The tax information. Includes the tax name and tax rate of invoice items. The tax amount is added to the item total.",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the tax applied on the invoice items.",
      "maxLength": 100
    },
    "percent": {
      "$ref": "#/components/schemas/percentage",
      "description": "The tax rate. Value is from `0` to `100`. Supports up to five decimal places."
    },
    "amount": {
      "$ref": "#/components/schemas/money",
      "description": "The calculated tax amount. The tax amount is added to the item total.",
      "readOnly": true
    }
  },
  "required": [
    "name",
    "percent"
  ]
}