Retrieve a Payment Rule
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Headers
Pins the request to a dated API version.
"2026-09-15"
Path Parameters
The payment rule ID.
Response
A partner can read a rule without being able to write one
Account ID, prefixed biz_.
"biz_xxxxxxxxxxxxxx"
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.
allow, block, enforce_3ds "block"
The conditions a payment is matched against. Up to 10 conditions, and 8 KiB once serialized.
When the rule was created, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
When the rule was deleted, as an ISO 8601 timestamp. null unless status is deleted.
Payment rule ID, prefixed prule_.
"prule_xxxxxxxxxxxxxx"
Custom string-to-string values for your integration. Maximum 50 keys, 40 characters per key, 500 characters per value.
A name for this rule. Up to 255 characters.
"Block high risk"
Whether the rule is applied to payments. A deleted rule is kept so the payments it already decided still name it.
active, inactive, deleted "active"
When the rule was last changed, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"

