Sign in
Payment Rules

Replace a payment rule

Deletes this rule and creates its successor in one step. The successor carries a new ID and the metadata of the rule it replaced,.

post/payment_rules/{id}/replace

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

action'allow' | 'block' | 'enforce_3ds' required

What happens to a payment when every condition matches. An allow overrides this account's other rules only, never Whop's own fraud controls. An enforce_3ds is skipped where the payment cannot carry a challenge.

Example request

{
  "action": "block",
  "conditions": {
    "all": [
      {
        "field": "risk_score",
        "operator": "gte"
      }
    ]
  }
}

Response

The rule that replaced this one

account_idstring required

Account ID, prefixed biz_.

action'allow' | 'block' | 'enforce_3ds' required

What happens to a payment when every condition matches. An allow overrides this account's other rules only, never Whop's own fraud controls. An enforce_3ds is skipped where the payment cannot carry a challenge.

created_atstring required

When the rule was created, as an ISO 8601 timestamp.

deleted_atstring nullable required

When the rule was deleted, as an ISO 8601 timestamp. null unless status is deleted.

idstring required

Payment rule ID, prefixed prule_.

metadataobject required

Custom string-to-string values for your integration. Maximum 50 keys, 40 characters per key, 500 characters per value.

namestring required

A name for this rule. Up to 255 characters.

status'active' | 'inactive' | 'deleted' required

Whether the rule is applied to payments. A deleted rule is kept so the payments it already decided still name it.

updated_atstring required

When the rule was last changed, as an ISO 8601 timestamp.

Example response

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "action": "block",
  "conditions": {
    "all": [
      {
        "field": "risk_score",
        "operator": "gte"
      }
    ]
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "id": "prule_xxxxxxxxxxxxxx",
  "metadata": {},
  "name": "Block high risk",
  "status": "active",
  "updated_at": "2026-01-01T12:00:00.000Z"
}

Changes