Fully update conditional rule

Fully updates conditional rule for the invoice. In the JSON request body, include a complete `conditional rule` object. This call does not support partial updates.

Authorization

AuthorizationBearer <token>

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

For managing (Create, Update, Delete) invoice.https://uri.paypal.com/services/invoicing/invoices/readwrite
Manage invoice resource internal clients.https://uri.paypal.com/services/invoicing/internal

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

conditional_rule_typeenum<conditional_rule_type>Required

This enum defines what type of rule is applying for the particular 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"

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

Response Body

`application/json`

curl -X PUT "https://example.com/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75ED" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "Content-Type: application/json" \  -d '{    "conditional_rule_type": "EARLY_PAYMENT_DISCOUNT",    "conditional_rule_value_type": "PERCENT",    "conditional_rule_value": "10",    "rule_expiry_terms": {      "rule_expiry_condition": "SEVEN_DAYS_AFTER_ISSUE_DATE",      "condition_rule_end_date": "2025-03-12"    }  }'

{  "conditional_rule_id": "CR-11FF-A725-27C6999C-A699-33CD614E75EC",  "conditional_rule_type": "EARLY_PAYMENT_DISCOUNT",  "conditional_rule_value_type": "PERCENT",  "conditional_rule_value": "10",  "rule_expiry_terms": {    "rule_expiry_condition": "SEVEN_DAYS_AFTER_ISSUE_DATE",    "condition_rule_end_date": "2025-03-12"  },  "created_time": "2025-01-29T10:15:30Z",  "updated_time": "2025-01-29T10:15:30Z",  "links": [    {      "href": "v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75EC",      "rel": "self",      "method": "GET"    },    {      "href": "v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75EC",      "rel": "delete",      "method": "DELETE"    }  ]}

Path Parameters

Header Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

conditional_rule_typeenum<conditional_rule_type>Required

This enum defines what type of rule is applying for the particular 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"

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

curl -X PUT "https://example.com/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75ED" \ -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \ -H "Content-Type: application/json" \ -d '{ "conditional_rule_type": "EARLY_PAYMENT_DISCOUNT", "conditional_rule_value_type": "PERCENT", "conditional_rule_value": "10", "rule_expiry_terms": { "rule_expiry_condition": "SEVEN_DAYS_AFTER_ISSUE_DATE", "condition_rule_end_date": "2025-03-12" } }'

{ "conditional_rule_id": "CR-11FF-A725-27C6999C-A699-33CD614E75EC", "conditional_rule_type": "EARLY_PAYMENT_DISCOUNT", "conditional_rule_value_type": "PERCENT", "conditional_rule_value": "10", "rule_expiry_terms": { "rule_expiry_condition": "SEVEN_DAYS_AFTER_ISSUE_DATE", "condition_rule_end_date": "2025-03-12" }, "created_time": "2025-01-29T10:15:30Z", "updated_time": "2025-01-29T10:15:30Z", "links": [ { "href": "v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75EC", "rel": "self", "method": "GET" }, { "href": "v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75EC", "rel": "delete", "method": "DELETE" } ]}

Authorization

Path Parameters

Header Parameters

Request Body

rule_expiry_terms properties

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

On this page

On this page

On this page

Fully update conditional rule

Authorization

Path Parameters

Header Parameters

Request Body

rule_expiry_terms properties

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

On this page

On this page

Fully update conditional rule

rule_expiry_terms properties

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

defaultapplication/json

On this page

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

Fully update conditional rule

rule_expiry_terms properties

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

defaultapplication/json

On this page

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`