Retrieves all conditional rules for a given Invoice.

Retrieves all conditional rules details for an Invoice. The response includes a list of conditional rules associated with the invoice, along with their details such as rule type, value, expiry terms etc.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

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

Scopes

For Reading the invoice details.https://uri.paypal.com/services/invoicing/invoices/read

Path Parameters

id*string

The ID of the invoice for which to show details.

Match^INV2-[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}$

Length24 <= length <= 24

Header Parameters

Authorization?Schema Object for standard headers

Holds authorization information for external API calls.

Match^.*$

Length1 <= length <= 16000

Response Body

`application/json`

curl -X GET "https://api-m.sandbox.paypal.com/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"

{
  "rules": [
    {
      "conditional_rule_id": "CR-11FF-A725-27C6999C-A699-33CD614E75ED",
      "conditional_rule_type": "EARLY_PAYMENT_DISCOUNT",
      "conditional_rule_value_type": "PERCENT",
      "conditional_rule_value": "5",
      "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-33CD614E75ED",
          "rel": "self",
          "method": "GET"
        },
        {
          "rel": "self",
          "href": "https://api.paypal.com/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C",
          "method": "GET"
        },
        {
          "href": "/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75ED",
          "rel": "update",
          "method": "PUT"
        },
        {
          "href": "/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75ED",
          "rel": "delete",
          "method": "DELETE"
        }
      ]
    },
    {
      "conditional_rule_id": "CR-11FF-A725-27C6999C-A699-33CD614E75EC",
      "conditional_rule_type": "AUTO_CANCEL",
      "rule_expiry_terms": {
        "rule_expiry_condition": "SPECIFIC_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": "update",
          "method": "PUT"
        },
        {
          "href": "/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75EC",
          "rel": "delete",
          "method": "DELETE"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C",
      "rel": "invoice",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [],
  "links": []
}

{
  "name": "AUTHENTICATION_FAILURE",
  "debug_id": "b1d1f06c7246c",
  "message": "Authentication failed due to missing Authorization header, or invalid authentication credentials."
}

{
  "name": "NOT_AUTHORIZED",
  "debug_id": "b1d1f06c7246c",
  "message": "Authorization failed due to insufficient permissions."
}

{
  "name": "RESOURCE_NOT_FOUND",
  "message": "The specified resource does not exist.",
  "debug_id": "13baa436f527b",
  "links": [
    {
      "href": "https://developer.paypal.com/docs/limited-release/invoicing/#errors",
      "rel": "information_link",
      "method": "GET"
    }
  ]
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "debug_id": "b1d1f06c7246c",
  "message": "An internal server error has occurred."
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "debug_id": "b1d1f06c7246c",
  "message": "An internal server error has occurred."
}

Retrieves all conditional rules for a given Invoice.

API v2

API v1

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

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

Scopes

For Reading the invoice details.https://uri.paypal.com/services/invoicing/invoices/read

Path Parameters

id*string

The ID of the invoice for which to show details.

Match^INV2-[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}$

Length24 <= length <= 24

Header Parameters

Authorization?Schema Object for standard headers

Holds authorization information for external API calls.

Match^.*$

Length1 <= length <= 16000

Response Body

`application/json`

curl -X GET "https://api-m.sandbox.paypal.com/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ"

{
  "rules": [
    {
      "conditional_rule_id": "CR-11FF-A725-27C6999C-A699-33CD614E75ED",
      "conditional_rule_type": "EARLY_PAYMENT_DISCOUNT",
      "conditional_rule_value_type": "PERCENT",
      "conditional_rule_value": "5",
      "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-33CD614E75ED",
          "rel": "self",
          "method": "GET"
        },
        {
          "rel": "self",
          "href": "https://api.paypal.com/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C",
          "method": "GET"
        },
        {
          "href": "/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75ED",
          "rel": "update",
          "method": "PUT"
        },
        {
          "href": "/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75ED",
          "rel": "delete",
          "method": "DELETE"
        }
      ]
    },
    {
      "conditional_rule_id": "CR-11FF-A725-27C6999C-A699-33CD614E75EC",
      "conditional_rule_type": "AUTO_CANCEL",
      "rule_expiry_terms": {
        "rule_expiry_condition": "SPECIFIC_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": "update",
          "method": "PUT"
        },
        {
          "href": "/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules/CR-11FF-A725-27C6999C-A699-33CD614E75EC",
          "rel": "delete",
          "method": "DELETE"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C/conditional-rules",
      "rel": "self",
      "method": "GET"
    },
    {
      "href": "/v2/invoicing/invoices/INV2-S884-EJT6-73AU-QF4C",
      "rel": "invoice",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [],
  "links": []
}

{
  "name": "AUTHENTICATION_FAILURE",
  "debug_id": "b1d1f06c7246c",
  "message": "Authentication failed due to missing Authorization header, or invalid authentication credentials."
}

{
  "name": "NOT_AUTHORIZED",
  "debug_id": "b1d1f06c7246c",
  "message": "Authorization failed due to insufficient permissions."
}

{
  "name": "RESOURCE_NOT_FOUND",
  "message": "The specified resource does not exist.",
  "debug_id": "13baa436f527b",
  "links": [
    {
      "href": "https://developer.paypal.com/docs/limited-release/invoicing/#errors",
      "rel": "information_link",
      "method": "GET"
    }
  ]
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "debug_id": "b1d1f06c7246c",
  "message": "An internal server error has occurred."
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "debug_id": "b1d1f06c7246c",
  "message": "An internal server error has occurred."
}

Retrieves all conditional rules for a given Invoice.

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

defaultapplication/json

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

Retrieves all conditional rules for a given Invoice.

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

defaultapplication/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`

`application/json`