---
title: Update a payment rule
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/python)

[Monetization](https://developers.cloudflare.com/api/python/resources/monetization)

[Rules](https://developers.cloudflare.com/api/python/resources/monetization/subresources/rules)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Update a payment rule

monetization.rules.edit\_rule(strrule\_id, RuleEditRuleParams\*\*kwargs) -> [MonetizationRuleCollection](<https://developers.cloudflare.com/api/python/resources/monetization#(resource)%20monetization.rules%20%3E%20(model)%20monetization_rule_collection%20%3E%20(schema)>)

PATCH/zones/{zone\_id}/monetization/rules/{rule\_id}

Applies a partial update to a single Payment Required rule. Only the fields present in the request body are changed; omitted fields keep their current values. Returns the full resulting rule collection.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### ParametersExpand Collapse

zone\_id: str

The unique ID of the zone.

[Link to this property](<#(resource)%20monetization.rules%20%3E%20(method)%20edit_rule%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)

rule\_id: str

maxLength32

[Link to this property](<#(resource)%20monetization.rules%20%3E%20(method)%20edit_rule%20%3E%20(params)%20default%20%3E%20(param)%20rule_id%20%3E%20(schema)>)

address: Optional\[str]

0x-prefixed 20-byte hexadecimal Ethereum address. Mixed-case addresses must carry a valid EIP-55 checksum; all-lowercase or all-uppercase addresses are also accepted. The effective address must pass wallet screening whenever the rule is patched.

[Link to this property](<#(resource)%20monetization.rules%20%3E%20(method)%20edit_rule%20%3E%20(params)%20default%20%3E%20(param)%20address%20%3E%20(schema)>)

description: Optional\[str]

maxLength512

[Link to this property](<#(resource)%20monetization.rules%20%3E%20(method)%20edit_rule%20%3E%20(params)%20default%20%3E%20(param)%20description%20%3E%20(schema)>)

enabled: Optional\[[bool](<https://developers.cloudflare.com/api/python/resources/monetization/subresources/rules/methods/edit_rule#(resource)%20monetization.rules%20%3E%20(method)%20edit_rule%20%3E%20(params)%20default%20%3E%20(param)%20enabled%20%3E%20(schema)>)]

[Link to this property](<#(resource)%20monetization.rules%20%3E%20(method)%20edit_rule%20%3E%20(params)%20default%20%3E%20(param)%20enabled%20%3E%20(schema)>)

expression: Optional\[str]

Wirefilter expression identifying the requests that require payment. Forwarded verbatim to the Rulesets API, which validates its syntax.

[Link to this property](<#(resource)%20monetization.rules%20%3E%20(method)%20edit_rule%20%3E%20(params)%20default%20%3E%20(param)%20expression%20%3E%20(schema)>)

price: Optional\[str]

Price in the smallest indivisible unit of the configured payment token, encoded as a decimal string. Must be a canonical decimal integer in \[1000, 100000000]: no leading zeros, and a bare JSON number is rejected. The price is required for the fixed-price schemes (“exact” and “upto”) and must be at least 1000, the smallest amount the payment facilitator can settle ($0.001 for a 6-decimal token such as USDC), and at most 100000000 ($100 for a 6-decimal token). When the scheme is “origin\_controlled” the origin server sets pricing dynamically and the rule carries no price: the field must be omitted — any provided value, including “0”, is rejected because it would not be enforced. Responses always encode this as a string and omit it for “origin\_controlled” rules; the pattern matches exactly the set of values the server accepts.

[Link to this property](<#(resource)%20monetization.rules%20%3E%20(method)%20edit_rule%20%3E%20(params)%20default%20%3E%20(param)%20price%20%3E%20(schema)>)

<details>

<summary>

scheme: Optional\[Literal\["exact", "upto", "origin\_controlled"]]

X402 payment scheme. “exact” requires the specified payment amount; “upto” permits a payment up to the specified amount; “origin\_controlled” lets the origin server set pricing dynamically, in which case the rule carries no price and the price field must be omitted.

</summary>

One of the following:

"exact"

<a href="#(resource)%20monetization.rules%20%3E%20(method)%20edit_rule%20%3E%20(params)%20default%20%3E%20(param)%20scheme%20%3E%20(schema)%20%3E%20(member)%200">Link to this property</a>

"upto"

<a href="#(resource)%20monetization.rules%20%3E%20(method)%20edit_rule%20%3E%20(params)%20default%20%3E%20(param)%20scheme%20%3E%20(schema)%20%3E%20(member)%201">Link to this property</a>

"origin\_controlled"

<a href="#(resource)%20monetization.rules%20%3E%20(method)%20edit_rule%20%3E%20(params)%20default%20%3E%20(param)%20scheme%20%3E%20(schema)%20%3E%20(member)%202">Link to this property</a>

</details>

[Link to this property](<#(resource)%20monetization.rules%20%3E%20(method)%20edit_rule%20%3E%20(params)%20default%20%3E%20(param)%20scheme%20%3E%20(schema)>)

##### ReturnsExpand Collapse

<details>

<summary>

class MonetizationRuleCollection: …

The zone’s payment rules. Mirrors the shape of the ruleset submitted to the deploy endpoint, so the response can be read back as the desired state.

</summary>

<details>

<summary>

rules: List\[<a href="https://developers.cloudflare.com/api/python/resources/monetization#(resource)%20monetization.rules%20%3E%20(model)%20monetization_rule%20%3E%20(schema)">MonetizationRule</a>]

The zone’s payment rules, in the order they are evaluated. Empty when the zone has no payment rules.

</summary>

One of the following:

<details>

<summary>

class MonetizationRulesMonetizationRuleInputFixedPrice: …

Payment rule with a fixed price set at configuration time.

</summary>

id: str

The server-assigned unique ID of the payment rule. Stable across full-ruleset replacements.

maxLength32

<a href="#(resource)%20monetization.rules%20%3E%20(model)%20monetization_rule%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(entry)%201%20%3E%20(property)%20id">Link to this property</a>

</details>

<a href="#(resource)%20monetization.rules%20%3E%20(model)%20monetization_rule%20%3E%20(schema)%20%3E%20(variant)%200">Link to this property</a>

<details>

<summary>

class MonetizationRulesMonetizationRuleInputOriginControlled: …

Payment rule whose price the origin server sets dynamically. The rule carries no price and the price field must be omitted — any provided value, including “0”, is rejected because it would not be enforced.

</summary>

id: str

The server-assigned unique ID of the payment rule. Stable across full-ruleset replacements.

maxLength32

<a href="#(resource)%20monetization.rules%20%3E%20(model)%20monetization_rule%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(entry)%201%20%3E%20(property)%20id">Link to this property</a>

</details>

<a href="#(resource)%20monetization.rules%20%3E%20(model)%20monetization_rule%20%3E%20(schema)%20%3E%20(variant)%201">Link to this property</a>

</details>

<a href="#(resource)%20monetization.rules%20%3E%20(model)%20monetization_rule_collection%20%3E%20(schema)%20%3E%20(property)%20rules">Link to this property</a>

</details>

[Link to this property](<#(resource)%20monetization.rules%20%3E%20(model)%20monetization_rule_collection%20%3E%20(schema)>)

### Update a payment rule

Python

HTTPTypeScriptPythonGoTerraform

```
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
monetization_rule_collection = client.monetization.rules.edit_rule(
    rule_id="023e105f4ecef8ad9ca31a8372d0c353",
    zone_id="9f1839b6152d298aca64c4e906b6d074",
)
print(monetization_rule_collection.rules)
```

200 example

```
{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "rules": [
      {
        "address": "0x1234567890abcdef1234567890abcdef12345678===",
        "expression": "(http.request.uri.path eq \"/premium\" and http.request.method in {\"GET\" \"POST\"})",
        "price": "250000",
        "scheme": "exact",
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "description": "Premium API endpoint",
        "enabled": true
      }
    ]
  },
  "success": true
}
```

##### Returns Examples

200 example

```
{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "rules": [
      {
        "address": "0x1234567890abcdef1234567890abcdef12345678===",
        "expression": "(http.request.uri.path eq \"/premium\" and http.request.method in {\"GET\" \"POST\"})",
        "price": "250000",
        "scheme": "exact",
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "description": "Premium API endpoint",
        "enabled": true
      }
    ]
  },
  "success": true
}
```