Fully update a conditional rule for a recurring invoice

Fully updates a conditional rule for a recurring invoice. In the JSON request body, include a complete `conditional rule` object. This call does not support partial updates. `EARLY_PAYMENT_DISCOUNT` and `AUTO_CANCEL` rules are supported. Updates only affect future invoices generated after the update; already-generated invoices retain their existing materialized rules.

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
Legacy V1 API scope, retained for V2 APIs for backward compatibilityhttps://uri.paypal.com/services/invoicing

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 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.

Response Body

`application/json`

curl -X PUT "https://example.com/v2/invoicing/recurring-invoices/RI-9Y6699772R09889EE/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75EC" \  -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"    }  }'

{  "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"  },  "create_time": "2025-01-29T10:15:30Z",  "update_time": "2025-01-29T10:15:30Z",  "links": [    {      "href": "/v2/invoicing/recurring-invoices/RI-9Y6699772R09889EE/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75EC",      "rel": "self",      "method": "GET"    },    {      "href": "/v2/invoicing/recurring-invoices/RI-9Y6699772R09889EE/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75EC",      "rel": "delete",      "method": "DELETE"    }  ]}

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

curl -X PUT "https://example.com/v2/invoicing/recurring-invoices/RI-9Y6699772R09889EE/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75EC" \ -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" } }'

{ "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" }, "create_time": "2025-01-29T10:15:30Z", "update_time": "2025-01-29T10:15:30Z", "links": [ { "href": "/v2/invoicing/recurring-invoices/RI-9Y6699772R09889EE/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75EC", "rel": "self", "method": "GET" }, { "href": "/v2/invoicing/recurring-invoices/RI-9Y6699772R09889EE/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75EC", "rel": "delete", "method": "DELETE" } ]}

Authorization

Path Parameters

Header Parameters

Request Body

recurring_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 a conditional rule for a recurring invoice

Authorization

Path Parameters

Header Parameters

Request Body

recurring_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 a conditional rule for a recurring invoice

recurring_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 a conditional rule for a recurring invoice

recurring_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`