Business Platforms and marketplacesPlatforms Enterprise

Business Platforms and marketplaces Enterprise

Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

Recurring Conditional Rules List

The conditional rules associated with a recurring invoice. Conditional rules define automated actions or adjustments that apply to invoices generated by the series, such as early payment discounts or auto cancellation.

rulesobject<recurring_conditional_rule>[]Optional

The list of conditional rules created by the merchant.

Items1 <= length <= 5

recurring_conditional_rule properties

10 properties

conditional_rule_idstring<conditional_rule_time_based_uuid>Optional

A unique identifier for the conditional rule, This ID is generated as a time-based UUID (version 1) to ensure uniqueness and traceability of the rule creation time.

Match^CR-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{12}$Length39 <= length <= 39

conditional_rule_typeenum<conditional_rule_type>Required

This enum defines what type of rule is associated with the invoice or recurring invoice.

Allowed values

"EARLY_PAYMENT_DISCOUNT"
"AUTO_CANCEL"

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

conditional_rule_value_typeenum<conditional_rule_value_type>Optional

Type of the stored discount. Used to determine whether its percentage or absolute currency value.

Allowed values

"PERCENT"
"AMOUNT"

discount_idstringOptional

The unique identifier of the stored discount to be used as the early payment discount for the recurring invoice.

Match^DISC-[A-Z0-9]+$Length1 <= length <= 22

discount_namestringOptional

Represents the name of the stored discount.

Match^[a-zA-Z0-9\s]+$Length1 <= length <= 40

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.

recurring_rule_expiry_terms properties

1 property

rule_expiry_conditionenum<conditional_rule_relative_conditions>Required

Defines the time-based condition that triggers a conditional rule on a recurring invoice, expressed as a period relative to either the invoice issue date (for early payment discounts) or the invoice due date (for auto-cancellation).

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"

create_timestring<date_time>Optional

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Length20 <= length <= 64

update_timestring<date_time>Optional

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Length20 <= length <= 64

linksobject<link_description>[]Optional

HATEOAS links.

Items1 <= length <= 10

link_description properties

3 properties

hrefstringRequired

The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.

Match^.*$Length0 <= length <= 20000

relstringRequired

The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).

Match^.*$Length0 <= length <= 100

methodenumOptional

The HTTP method required to make the related call.

Allowed values

"CONNECT"
"DELETE"
"GET"
"HEAD"
"OPTIONS"
"PATCH"
"POST"
"PUT"

linksobject<link_description>[]Optional

HATEOAS link of the created resource.

Items1 <= length <= 8

link_description properties

3 properties

hrefstringRequired

Match^.*$Length0 <= length <= 20000

relstringRequired

Match^.*$Length0 <= length <= 100

methodenumOptional

The HTTP method required to make the related call.

Allowed values

"CONNECT"
"DELETE"
"GET"
"HEAD"
"OPTIONS"
"PATCH"
"POST"
"PUT"

Back to top

Recurring Conditional Rules List

rulesobject<recurring_conditional_rule>[]Optional

The list of conditional rules created by the merchant.

Items1 <= length <= 5

recurring_conditional_rule properties

10 properties

conditional_rule_idstring<conditional_rule_time_based_uuid>Optional

A unique identifier for the conditional rule, This ID is generated as a time-based UUID (version 1) to ensure uniqueness and traceability of the rule creation time.

Match^CR-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{12}$Length39 <= length <= 39

conditional_rule_typeenum<conditional_rule_type>Required

This enum defines what type of rule is associated with the invoice or recurring invoice.

Allowed values

"EARLY_PAYMENT_DISCOUNT"
"AUTO_CANCEL"

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

conditional_rule_value_typeenum<conditional_rule_value_type>Optional

Type of the stored discount. Used to determine whether its percentage or absolute currency value.

Allowed values

"PERCENT"
"AMOUNT"

discount_idstringOptional

The unique identifier of the stored discount to be used as the early payment discount for the recurring invoice.

Match^DISC-[A-Z0-9]+$Length1 <= length <= 22

discount_namestringOptional

Represents the name of the stored discount.

Match^[a-zA-Z0-9\s]+$Length1 <= length <= 40

rule_expiry_termsobject<recurring_rule_expiry_terms>Required

recurring_rule_expiry_terms properties

1 property

rule_expiry_conditionenum<conditional_rule_relative_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"

create_timestring<date_time>Optional

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Length20 <= length <= 64

update_timestring<date_time>Optional

The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.

Note: The regular expression provides guidance but does not reject all invalid dates.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Length20 <= length <= 64

linksobject<link_description>[]Optional

HATEOAS links.

Items1 <= length <= 10

link_description properties

3 properties

hrefstringRequired

Match^.*$Length0 <= length <= 20000

relstringRequired

Match^.*$Length0 <= length <= 100

methodenumOptional

The HTTP method required to make the related call.

Allowed values

"CONNECT"
"DELETE"
"GET"
"HEAD"
"OPTIONS"
"PATCH"
"POST"
"PUT"

linksobject<link_description>[]Optional

HATEOAS link of the created resource.

Items1 <= length <= 8

link_description properties

3 properties

hrefstringRequired

Match^.*$Length0 <= length <= 20000

relstringRequired

Match^.*$Length0 <= length <= 100

methodenumOptional

The HTTP method required to make the related call.

Allowed values

"CONNECT"
"DELETE"
"GET"
"HEAD"
"OPTIONS"
"PATCH"
"POST"
"PUT"

Recurring Conditional Rules List

recurring_conditional_rule properties

recurring_rule_expiry_terms properties

link_description properties

link_description properties

Back to top

On this page

On this page

Recurring Conditional Rules List

recurring_conditional_rule properties

recurring_rule_expiry_terms properties

link_description properties

link_description properties

Back to top

On this page

Recurring Conditional Rules List

recurring_conditional_rule properties

recurring_rule_expiry_terms properties

link_description 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 Rules List

recurring_conditional_rule properties

recurring_rule_expiry_terms properties

link_description properties

link_description properties

Back to top

On this page