--- title: Monetization --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Monetization ##### ModelsExpand Collapse

MonetizationAccountEligibilityCheckInput {acceptedTermsOfService }

acceptedTermsOfService: true Confirms acceptance of the Monetization Gateway terms of service. Link to this property

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

MonetizationAccountEligibilityCheckResponse {errors, messages, result, success }

errors: Array<Error>

code?: number Link to this property message?: string Link to this property

Link to this property

messages: Array<Message>

code?: number Link to this property message?: string Link to this property

Link to this property result: MonetizationEligibilityResult {status, reasons } Link to this property success: true Link to this property

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

MonetizationEligibilityResponse {errors, messages, result, success }

errors: Array<Error>

code?: number Link to this property message?: string Link to this property

Link to this property

messages: Array<Message>

code?: number Link to this property message?: string Link to this property

Link to this property result: MonetizationEligibilityResult {status, reasons } Link to this property success: true Link to this property

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

MonetizationEligibilityResult {status, reasons }

status: "pending"| "approved"| "rejected" Current monetization eligibility decision.

One of the following: "pending" Link to this property "approved" Link to this property "rejected" Link to this property

Link to this property reasons?: Array<string> Public, human-readable reasons for a rejected decision, when available. Link to this property

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

MonetizationZoneEligibilityCheckResponse {errors, messages, result, success }

errors: Array<Error>

code?: number Link to this property message?: string Link to this property

Link to this property

messages: Array<Message>

code?: number Link to this property message?: string Link to this property

Link to this property

result: Result {enabled, status, reasons }

enabled: boolean Whether this check successfully enabled the zone entitlement. Only approved decisions can enable it. Link to this property

status: "pending"| "approved"| "rejected" Current monetization eligibility decision.

One of the following: "pending" Link to this property "approved" Link to this property "rejected" Link to this property

Link to this property reasons?: Array<string> Public, human-readable reasons for a rejected decision, when available. Link to this property

Link to this property success: true Link to this property

[Link to this property](<#(resource)%20monetization%20%3E%20(model)%20monetization_zone_eligibility_check_response%20%3E%20(schema)>) #### MonetizationRules ##### [List payment rules](https://developers.cloudflare.com/api/typescript/resources/monetization/subresources/rules/methods/get) client.monetization.rules.get(RuleGetParams {zone\_id } params, RequestOptionsoptions?): [MonetizationRuleCollection]() {rules } GET/zones/{zone\_id}/monetization/rules ##### [Deploy payment ruleset](https://developers.cloudflare.com/api/typescript/resources/monetization/subresources/rules/methods/update) client.monetization.rules.update(RuleUpdateParams {zone\_id, rules } params, RequestOptionsoptions?): [MonetizationRuleCollection]() {rules } PUT/zones/{zone\_id}/monetization/rules ##### [Delete all payment rules](https://developers.cloudflare.com/api/typescript/resources/monetization/subresources/rules/methods/delete) client.monetization.rules.delete(RuleDeleteParams {zone\_id } params, RequestOptionsoptions?): [MonetizationRuleCollection]() {rules } DELETE/zones/{zone\_id}/monetization/rules ##### [Get a payment rule](https://developers.cloudflare.com/api/typescript/resources/monetization/subresources/rules/methods/get_rule) client.monetization.rules.getRule(stringruleID, RuleGetRuleParams {zone\_id } params, RequestOptionsoptions?): [MonetizationRule]() GET/zones/{zone\_id}/monetization/rules/{rule\_id} ##### [Update a payment rule](https://developers.cloudflare.com/api/typescript/resources/monetization/subresources/rules/methods/edit_rule) client.monetization.rules.editRule(stringruleID, RuleEditRuleParams {zone\_id, address, description, 4 more } params, RequestOptionsoptions?): [MonetizationRuleCollection]() {rules } PATCH/zones/{zone\_id}/monetization/rules/{rule\_id} ##### [Delete a payment rule](https://developers.cloudflare.com/api/typescript/resources/monetization/subresources/rules/methods/delete_rule) client.monetization.rules.deleteRule(stringruleID, RuleDeleteRuleParams {zone\_id } params, RequestOptionsoptions?): [MonetizationRuleCollection]() {rules } DELETE/zones/{zone\_id}/monetization/rules/{rule\_id} ##### ModelsExpand Collapse

MonetizationRule = MonetizationRulesMonetizationRuleInputFixedPrice {id } | MonetizationRulesMonetizationRuleInputOriginControlled {id } Payment rule with a fixed price set at configuration time.

One of the following:

MonetizationRulesMonetizationRuleInputFixedPrice extends MonetizationRuleInputFixedPrice {address, expression, price, 4 more } {id } 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

MonetizationRulesMonetizationRuleInputOriginControlled extends MonetizationRuleInputOriginControlled {address, expression, scheme, 3 more } {id } 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)>)

MonetizationRuleCollection {rules } 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: Array<MonetizationRule> The zone’s payment rules, in the order they are evaluated. Empty when the zone has no payment rules.

One of the following:

MonetizationRulesMonetizationRuleInputFixedPrice extends MonetizationRuleInputFixedPrice {address, expression, price, 4 more } {id } 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

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_collection%20%3E%20(schema)>)

MonetizationRuleInput = MonetizationRuleInputFixedPrice {address, expression, price, 4 more } | MonetizationRuleInputOriginControlled {address, expression, scheme, 3 more } Payment rule with a fixed price set at configuration time.

One of the following:

MonetizationRuleInputFixedPrice {address, expression, price, 4 more } 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: "exact"| "upto" 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: "exact" Link to this property "upto" Link to this property

Link to this property id?: string 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?: string maxLength512 Link to this property enabled?: boolean Link to this property

Link to this property

MonetizationRuleInputOriginControlled {address, expression, scheme, 3 more } 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: "origin\_controlled" 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?: string 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?: string maxLength512 Link to this property enabled?: boolean 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)>)

MonetizationRuleInputFixedPrice {address, expression, price, 4 more } Payment rule with a fixed price set at configuration time.

One of the following: "exact" Link to this property "upto" Link to this property

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

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: "origin\_controlled" 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?: string 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?: string maxLength512 Link to this property enabled?: boolean Link to this property

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

MonetizationRulePatch {address, description, enabled, 3 more } Partial update to a single payment rule. Only the fields present are modified; omitted fields keep their existing values.

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 effective address must pass wallet screening whenever the rule is patched. Link to this property description?: string maxLength512 Link to this property enabled?: boolean 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?: "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.

One of the following: "exact" Link to this property "upto" Link to this property "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)>)

MonetizationRulesetInput {rules }

rules: Array<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:

MonetizationRuleInputFixedPrice {address, expression, price, 4 more } Payment rule with a fixed price set at configuration time.

One of the following: "exact" Link to this property "upto" Link to this property

Link to this property

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: "origin\_controlled" 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?: string 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?: string maxLength512 Link to this property enabled?: boolean 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)>)