PayPal · Schema

Custom Amount

The custom amount to apply to an invoice. If you include a label, you must include a custom amount.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name Type Description
label string The label to the custom amount of the invoice.
amount object The custom amount value. Value is from `-1000000` to `1000000`. Supports up to two decimal places.
View JSON Schema on GitHub

JSON Schema

paypal-custom-amount-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/custom_amount",
  "title": "Custom Amount",
  "type": "object",
  "description": "The custom amount to apply to an invoice. If you include a label, you must include a custom amount.",
  "required": [
    "label"
  ],
  "properties": {
    "label": {
      "type": "string",
      "description": "The label to the custom amount of the invoice.",
      "maxLength": 50
    },
    "amount": {
      "$ref": "#/components/schemas/money",
      "description": "The custom amount value. Value is from `-1000000` to `1000000`. Supports up to two decimal places."
    }
  }
}