Get a payment rule

GET/zones/{zone_id}/monetization/rules/{rule_id}

Returns a single Payment Required rule identified by its ID.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

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

Example:X-Auth-Email: user@example.com

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

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Path ParametersExpand Collapse

zone_id: string

The unique ID of the zone.

rule_id: string

maxLength32

ReturnsExpand Collapse

errors: array of object { code, message }

code: optional number

message: optional string

messages: array of object { code, message }

code: optional number

message: optional string

result: MonetizationRule

Payment rule with a fixed price set at configuration time.

One of the following:

MonetizationRulesMonetizationRuleInputFixedPrice = MonetizationRuleInputFixedPrice { address, expression, price, 4 more }

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

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

id: string

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

maxLength32

success: true

Get a payment rule

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/monetization/rules/$RULE_ID \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "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

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "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
}