PayPal · Schema

Incentive Details

The incentive details.

BillingCommerceDisputesInvoicesOrdersPaymentsPayoutsSubscriptionsTokensWebhooks

Properties

Name	Type	Description
incentive_type	string	The type of incentive, such as a special offer or coupon.
incentive_code	string	The code that identifies an incentive, such as a coupon.
incentive_amount	object	The incentive amount.
incentive_program_code	string	The incentive program code that identifies a merchant loyalty or incentive program.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/incentive_detail",
  "title": "Incentive Details",
  "type": "object",
  "description": "The incentive details.",
  "properties": {
    "incentive_type": {
      "type": "string",
      "description": "The type of incentive, such as a special offer or coupon.",
      "minLength": 1,
      "maxLength": 500,
      "pattern": "^[a-zA-Z0-9_'\\-., \":;\\!?]*$"
    },
    "incentive_code": {
      "type": "string",
      "description": "The code that identifies an incentive, such as a coupon.",
      "minLength": 1,
      "maxLength": 200,
      "pattern": "^[a-zA-Z0-9_'\\-., \":;\\!?]*$"
    },
    "incentive_amount": {
      "$ref": "#/components/schemas/money",
      "description": "The incentive amount."
    },
    "incentive_program_code": {
      "type": "string",
      "description": "The incentive program code that identifies a merchant loyalty or incentive program.",
      "minLength": 1,
      "maxLength": 100,
      "pattern": "^[a-zA-Z0-9_'\\-., \":;\\!?]*$"
    }
  }
}