rules

The conditional rule fields that define automated actions or adjustments applied by the merchant to an invoice, such as early payment discounts or auto cancellation.

conditional_rule_valuestringOptional

Represents the value of the conditional rule it can be a percentage or absolute value. In case of absolute 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.

For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).

Match^(([0-9]+)|(([0-9]+)?[.][0-9]+))$Length1 <= length <= 32

rule_expiry_termsobject<rule_expiry_terms>Required

The expiry terms that define when a conditional rule on an invoice expires, including the expiry condition and the end date.

rule_expiry_terms properties

2 properties

rule_expiry_conditionenum<conditional_rule_conditions>Required

Defines the time-based condition that triggers the application of this conditional rule. This is expressed as a period relative to either the invoice issue date (for early payment discounts) or the invoice due date (for late payment surcharges and auto-cancellation). If the value is 'SPECIFIC_DATE', the 'effective_date' field must be provided to specify the exact date.

Allowed values

"THREE_DAYS_AFTER_ISSUE_DATE"
"SEVEN_DAYS_AFTER_ISSUE_DATE"
"FIFTEEN_DAYS_AFTER_ISSUE_DATE"
"THIRTY_DAYS_AFTER_ISSUE_DATE"
"ONE_DAY_AFTER_DUE_DATE"
"SEVEN_DAYS_AFTER_DUE_DATE"
"FIFTEEN_DAYS_AFTER_DUE_DATE"
"THIRTY_DAYS_AFTER_DUE_DATE"
"SPECIFIC_DATE"

condition_rule_end_datestring<date_no_time>Required

The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard `date_time` type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Length10 <= length <= 10

linksobject<link_description>[]Optional

HATEOAS links.

Items1 <= length <= 10

The conditional rule fields that define automated actions or adjustments applied by the merchant to an invoice, such as early payment discounts or auto cancellation.

conditional_rule_valuestringOptional

Represents the value of the conditional rule it can be a percentage or absolute value. In case of absolute 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.

For the required number of decimal places for a currency code, see [Currency Codes](/docs/integration/direct/rest/currency-codes/).

Match^(([0-9]+)|(([0-9]+)?[.][0-9]+))$Length1 <= length <= 32

rule_expiry_termsobject<rule_expiry_terms>Required

The expiry terms that define when a conditional rule on an invoice expires, including the expiry condition and the end date.

rule_expiry_terms properties

2 properties

rule_expiry_conditionenum<conditional_rule_conditions>Required

Allowed values

"THREE_DAYS_AFTER_ISSUE_DATE"
"SEVEN_DAYS_AFTER_ISSUE_DATE"
"FIFTEEN_DAYS_AFTER_ISSUE_DATE"
"THIRTY_DAYS_AFTER_ISSUE_DATE"
"ONE_DAY_AFTER_DUE_DATE"
"SEVEN_DAYS_AFTER_DUE_DATE"
"FIFTEEN_DAYS_AFTER_DUE_DATE"
"THIRTY_DAYS_AFTER_DUE_DATE"
"SPECIFIC_DATE"

condition_rule_end_datestring<date_no_time>Required

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Length10 <= length <= 10

linksobject<link_description>[]Optional

HATEOAS links.

Items1 <= length <= 10

rules

rule_expiry_terms properties

link_description properties

Back to top

On this page

On this page

rules

rule_expiry_terms properties

link_description properties

Back to top

On this page

rules

rule_expiry_terms properties

link_description properties

Back to top

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

rules

rule_expiry_terms properties

link_description properties

Back to top

On this page