Recurring Conditional Rule

The conditional rule associated with a recurring invoice that defines automated actions or adjustments applied to invoices generated by the series, 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<recurring_rule_expiry_terms>Required

The expiry terms that define when a conditional rule expires. Unlike an invoice, a recurring invoice has no fixed issue or due date, so an end date cannot be resolved at the series level; it is instead populated on the conditional rules materialized against each generated invoice.

linksobject<link_description>[]Optional

HATEOAS links.

Items1 <= length <= 10

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<recurring_rule_expiry_terms>Required

linksobject<link_description>[]Optional

HATEOAS links.

Items1 <= length <= 10

Recurring Conditional Rule

recurring_rule_expiry_terms properties

link_description properties

Back to top

On this page

On this page

Recurring Conditional Rule

recurring_rule_expiry_terms properties

link_description properties

Back to top

On this page

Recurring Conditional Rule

recurring_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

Recurring Conditional Rule

recurring_rule_expiry_terms properties

link_description properties

Back to top

On this page