Skip to main content
A conversion value rule allows you to report accurate conversion values to Whop while modifying how those values are sent to ad networks. Rules belong to an account and can apply to an account, an ad campaign, an ad group, or an ad. Each rule contains targets and events that share one value adjustment. Every selected event applies to every selected target. Create, retrieve, edit, delete, pause, or resume one rule by its ID. Create may set an initial active or paused status. Edits keep that status. Filter the list with resource_id to find rules overlapping a campaign, ad group, or ad. Every target must support every selected event; Google does not support named custom events. Create and edit accept replace_rule_ids to replace only the overlapping selections in the same transaction. Other selections keep their values. Remaining selections may split into separate rules so every event still applies to every target. Broader rules remain as fallbacks for other items; the most specific rule applies. Rules with no remaining selections are paused. Unpause automatically replaces overlapping selections using the same behavior as create and edit: other selections keep their values, and broader rules remain as defaults. Resuming an already-active rule makes no changes. Each write succeeds or fails as one transaction. Use Idempotency-Key to safely retry POST requests. Each conversion send attempt uses the rules saved at that time, including retries.

​
Endpoints

​
Attributes

​
string
required
Conversion value rule ID, prefixed adcvr_.
​
string
required
Business that owns this shared, editable rule.
​
string
required
Set a fixed amount or change the original value by a signed percentage.Available options: fixed, percentage
​
string
required
When the rule was created, as an ISO 8601 timestamp.
​
object[]
required
Events adjusted on every selected target.

Properties

​
string | null
required
Exact custom event name. Null for standard events.
​
string
required
Event to adjust. Purchase includes Whop purchases and external purchase events.Available options: purchase, subscribe, start_trial, lead, complete_registration, submit_application, schedule, contact, view_content, add_to_cart, custom
​
object | null
required
Amount sent for a fixed rule. Null for a percentage rule.

Properties

​
string
required
The amount in major units, as an exact decimal string — "10.00" is ten dollars. A string so no float rounds it in transit.
​
string
required
Three-letter ISO 4217 currency code, lowercase.
​
integer
required
How many decimal places the amount CARRIES — the precision the charge itself runs at.
​
integer
required
How many decimal places to SHOW. Usually equal to decimals, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is 2 and 0. Format the number in your own locale using this.
​
object
required
Free-form string keys and values for the caller.
​
number | null
required
Signed percent change: 20 increases by 20%, negative 20 decreases by 20%. The sent value cannot go below zero. Null for a fixed rule.
​
string
required
Whether this rule is active or paused.Available options: active, paused
​
object[]
required
Targets covered by this rule. Every selected event applies to every target.

Properties

​
string
required
Ad platform that receives the adjusted value.Available options: tiktok, meta, google
​
string | null
required
Selected campaign, ad group, or ad ID. Null for a business target.
​
string | null
required
Name of the selected item. Null when it is no longer available.
​
string
required
Business, campaign, ad group, or ad covered by this target.Available options: business, campaign, ad_group, ad
​
string
required
When the rule was edited, as an ISO 8601 timestamp.
AdConversionValueRule