--- title: Rules --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Monetization](https://developers.cloudflare.com/api/go/resources/monetization) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Rules ##### [List payment rules](https://developers.cloudflare.com/api/go/resources/monetization/subresources/rules/methods/get) client.Monetization.Rules.Get(ctx, query) (\*[MonetizationRuleCollection](), error) GET/zones/{zone\_id}/monetization/rules ##### [Deploy payment ruleset](https://developers.cloudflare.com/api/go/resources/monetization/subresources/rules/methods/update) client.Monetization.Rules.Update(ctx, params) (\*[MonetizationRuleCollection](), error) PUT/zones/{zone\_id}/monetization/rules ##### [Delete all payment rules](https://developers.cloudflare.com/api/go/resources/monetization/subresources/rules/methods/delete) client.Monetization.Rules.Delete(ctx, body) (\*[MonetizationRuleCollection](), error) DELETE/zones/{zone\_id}/monetization/rules ##### [Get a payment rule](https://developers.cloudflare.com/api/go/resources/monetization/subresources/rules/methods/get_rule) client.Monetization.Rules.GetRule(ctx, ruleID, query) (\*[MonetizationRule](), error) GET/zones/{zone\_id}/monetization/rules/{rule\_id} ##### [Update a payment rule](https://developers.cloudflare.com/api/go/resources/monetization/subresources/rules/methods/edit_rule) client.Monetization.Rules.EditRule(ctx, ruleID, params) (\*[MonetizationRuleCollection](), error) PATCH/zones/{zone\_id}/monetization/rules/{rule\_id} ##### [Delete a payment rule](https://developers.cloudflare.com/api/go/resources/monetization/subresources/rules/methods/delete_rule) client.Monetization.Rules.DeleteRule(ctx, ruleID, body) (\*[MonetizationRuleCollection](), error) DELETE/zones/{zone\_id}/monetization/rules/{rule\_id} ##### ModelsExpand Collapse
type MonetizationRule interface{…} Payment rule with a fixed price set at configuration time. One of the following:
type MonetizationRuleMonetizationRulesMonetizationRuleInputFixedPrice struct{…} Payment rule with a fixed price set at configuration time. ID string The server-assigned unique ID of the payment rule. Stable across full-ruleset replacements. maxLength32 Link to this property
Link to this property
type MonetizationRuleMonetizationRulesMonetizationRuleInputOriginControlled struct{…} 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. ID string The server-assigned unique ID of the payment rule. Stable across full-ruleset replacements. maxLength32 Link to this property
Link to this property
[Link to this property](<#(resource)%20monetization.rules%20%3E%20(model)%20monetization_rule%20%3E%20(schema)>)
type MonetizationRuleCollection struct{…} 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.
Rules \[]MonetizationRule The zone’s payment rules, in the order they are evaluated. Empty when the zone has no payment rules. One of the following:
type MonetizationRuleMonetizationRulesMonetizationRuleInputFixedPrice struct{…} Payment rule with a fixed price set at configuration time. ID string The server-assigned unique ID of the payment rule. Stable across full-ruleset replacements. maxLength32 Link to this property
Link to this property
type MonetizationRuleMonetizationRulesMonetizationRuleInputOriginControlled struct{…} 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. ID string The server-assigned unique ID of the payment rule. Stable across full-ruleset replacements. maxLength32 Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20monetization.rules%20%3E%20(model)%20monetization_rule_collection%20%3E%20(schema)>)
type MonetizationRuleInput interface{…} Payment rule with a fixed price set at configuration time. One of the following:
type MonetizationRuleInputFixedPrice struct{…} Payment rule with a fixed price set at configuration time. Address string 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 address must pass wallet screening whenever its rule is deployed or patched. Link to this property Expression string Wirefilter expression identifying the requests that require payment. Forwarded verbatim to the Rulesets API, which validates its syntax. Link to this property Price string 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
Scheme MonetizationRuleInputFixedPriceScheme X402 payment scheme. “exact” requires the specified payment amount; “upto” permits a payment up to the specified amount. Both fixed-price schemes require the price field. One of the following: const MonetizationRuleInputFixedPriceSchemeExact MonetizationRuleInputFixedPriceScheme = "exact" Link to this property const MonetizationRuleInputFixedPriceSchemeUpto MonetizationRuleInputFixedPriceScheme = "upto" Link to this property
Link to this property ID stringOptional Optional on input. Include the ID of an existing payment rule to update it in place, preserving its stable identity across the full-ruleset replacement; omit it to create a new rule. An ID that does not match an existing payment rule in the zone is rejected. Rules omitted from the request are deleted. maxLength32 Link to this property Description stringOptional maxLength512 Link to this property Enabled boolOptional Link to this property
Link to this property
type MonetizationRuleInputOriginControlled struct{…} 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. Address string 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 address must pass wallet screening whenever its rule is deployed or patched. Link to this property Expression string Wirefilter expression identifying the requests that require payment. Forwarded verbatim to the Rulesets API, which validates its syntax. Link to this property Scheme MonetizationRuleInputOriginControlledScheme X402 payment scheme. “origin\_controlled” lets the origin server set pricing dynamically; the rule carries no price and the price field must be omitted. Link to this property ID stringOptional Optional on input. Include the ID of an existing payment rule to update it in place, preserving its stable identity across the full-ruleset replacement; omit it to create a new rule. An ID that does not match an existing payment rule in the zone is rejected. Rules omitted from the request are deleted. maxLength32 Link to this property Description stringOptional maxLength512 Link to this property Enabled boolOptional Link to this property
Link to this property
[Link to this property](<#(resource)%20monetization.rules%20%3E%20(model)%20monetization_rule_input%20%3E%20(schema)>)
type MonetizationRuleInputFixedPrice struct{…} Payment rule with a fixed price set at configuration time. Address string 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 address must pass wallet screening whenever its rule is deployed or patched. Link to this property Expression string Wirefilter expression identifying the requests that require payment. Forwarded verbatim to the Rulesets API, which validates its syntax. Link to this property Price string 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
Scheme MonetizationRuleInputFixedPriceScheme X402 payment scheme. “exact” requires the specified payment amount; “upto” permits a payment up to the specified amount. Both fixed-price schemes require the price field. One of the following: const MonetizationRuleInputFixedPriceSchemeExact MonetizationRuleInputFixedPriceScheme = "exact" Link to this property const MonetizationRuleInputFixedPriceSchemeUpto MonetizationRuleInputFixedPriceScheme = "upto" Link to this property
Link to this property ID stringOptional Optional on input. Include the ID of an existing payment rule to update it in place, preserving its stable identity across the full-ruleset replacement; omit it to create a new rule. An ID that does not match an existing payment rule in the zone is rejected. Rules omitted from the request are deleted. maxLength32 Link to this property Description stringOptional maxLength512 Link to this property Enabled boolOptional Link to this property
[Link to this property](<#(resource)%20monetization.rules%20%3E%20(model)%20monetization_rule_input_fixed_price%20%3E%20(schema)>)
type MonetizationRuleInputOriginControlled struct{…} 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. Address string 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 address must pass wallet screening whenever its rule is deployed or patched. Link to this property Expression string Wirefilter expression identifying the requests that require payment. Forwarded verbatim to the Rulesets API, which validates its syntax. Link to this property Scheme MonetizationRuleInputOriginControlledScheme X402 payment scheme. “origin\_controlled” lets the origin server set pricing dynamically; the rule carries no price and the price field must be omitted. Link to this property ID stringOptional Optional on input. Include the ID of an existing payment rule to update it in place, preserving its stable identity across the full-ruleset replacement; omit it to create a new rule. An ID that does not match an existing payment rule in the zone is rejected. Rules omitted from the request are deleted. maxLength32 Link to this property Description stringOptional maxLength512 Link to this property Enabled boolOptional Link to this property
[Link to this property](<#(resource)%20monetization.rules%20%3E%20(model)%20monetization_rule_input_origin_controlled%20%3E%20(schema)>)
type MonetizationRulePatch struct{…} Partial update to a single payment rule. Only the fields present are modified; omitted fields keep their existing values. Address stringOptional 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 Description stringOptional maxLength512 Link to this property Enabled boolOptional Link to this property Expression stringOptional Wirefilter expression identifying the requests that require payment. Forwarded verbatim to the Rulesets API, which validates its syntax. Link to this property Price stringOptional 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
Scheme MonetizationRulePatchSchemeOptional 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. One of the following: const MonetizationRulePatchSchemeExact MonetizationRulePatchScheme = "exact" Link to this property const MonetizationRulePatchSchemeUpto MonetizationRulePatchScheme = "upto" Link to this property const MonetizationRulePatchSchemeOriginControlled MonetizationRulePatchScheme = "origin\_controlled" Link to this property
Link to this property
[Link to this property](<#(resource)%20monetization.rules%20%3E%20(model)%20monetization_rule_patch%20%3E%20(schema)>)
type MonetizationRulesetInput struct{…}
Rules \[]MonetizationRuleInput Full desired Payment Required ruleset. An empty array clears all payment rules. The ruleset may contain at most 40 unique wallet addresses; address comparison is case-insensitive. Every address must pass wallet screening before deployment. One of the following:
type MonetizationRuleInputFixedPrice struct{…} Payment rule with a fixed price set at configuration time. Address string 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 address must pass wallet screening whenever its rule is deployed or patched. Link to this property Expression string Wirefilter expression identifying the requests that require payment. Forwarded verbatim to the Rulesets API, which validates its syntax. Link to this property Price string 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
Scheme MonetizationRuleInputFixedPriceScheme X402 payment scheme. “exact” requires the specified payment amount; “upto” permits a payment up to the specified amount. Both fixed-price schemes require the price field. One of the following: const MonetizationRuleInputFixedPriceSchemeExact MonetizationRuleInputFixedPriceScheme = "exact" Link to this property const MonetizationRuleInputFixedPriceSchemeUpto MonetizationRuleInputFixedPriceScheme = "upto" Link to this property
Link to this property ID stringOptional Optional on input. Include the ID of an existing payment rule to update it in place, preserving its stable identity across the full-ruleset replacement; omit it to create a new rule. An ID that does not match an existing payment rule in the zone is rejected. Rules omitted from the request are deleted. maxLength32 Link to this property Description stringOptional maxLength512 Link to this property Enabled boolOptional Link to this property
Link to this property
type MonetizationRuleInputOriginControlled struct{…} 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. Address string 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 address must pass wallet screening whenever its rule is deployed or patched. Link to this property Expression string Wirefilter expression identifying the requests that require payment. Forwarded verbatim to the Rulesets API, which validates its syntax. Link to this property Scheme MonetizationRuleInputOriginControlledScheme X402 payment scheme. “origin\_controlled” lets the origin server set pricing dynamically; the rule carries no price and the price field must be omitted. Link to this property ID stringOptional Optional on input. Include the ID of an existing payment rule to update it in place, preserving its stable identity across the full-ruleset replacement; omit it to create a new rule. An ID that does not match an existing payment rule in the zone is rejected. Rules omitted from the request are deleted. maxLength32 Link to this property Description stringOptional maxLength512 Link to this property Enabled boolOptional Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20monetization.rules%20%3E%20(model)%20monetization_ruleset_input%20%3E%20(schema)>)