Conversion Value Rule

A conversion value rule changes the conversion values Whop sends to ad networks while Whop keeps recording the accurate values. Each rule belongs to an account and applies one value adjustment to a set of targets (the account, an ad campaign, an ad group, or an ad) and events. Every selected event applies to every selected target, and the most specific rule applies. Use the Ad Conversion Value Rules API to create, edit, pause, resume, and delete rules, and to find the rules that cover a campaign, ad group, or ad. Each write succeeds or fails as one transaction, and each conversion send uses the rules saved at that moment.

Endpoints

Endpoint	Request
List conversion value rules	GET `/ad_conversion_value_rules`
Retrieve a conversion value rule	GET `/ad_conversion_value_rules/{id}`
Create a conversion value rule	POST `/ad_conversion_value_rules`
Pause a conversion value rule	POST `/ad_conversion_value_rules/{id}/pause`
Unpause a conversion value rule	POST `/ad_conversion_value_rules/{id}/unpause`
Update a conversion value rule	PATCH `/ad_conversion_value_rules/{id}`
Delete a conversion value rule	DELETE `/ad_conversion_value_rules/{id}`

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

{
	"id": "adcvr_3jT8kR2pN6sQ9x",
	"account_id": "biz_4dG8nR2qP9sT6v",
	"fixed_value": {
		"amount": "60.00",
		"currency": "usd",
		"decimals": 2,
		"display_decimals": 2
	},
	"metadata": {},
	"created_at": "2026-09-20T00:00:00.000Z",
	"updated_at": "2026-09-20T00:00:00.000Z",
	"adjustment_type": "fixed",
	"percentage_change": null,
	"targets": [
		{
			"scope": "business",
			"resource_id": null,
			"resource_title": "Torii",
			"platform": "meta"
		}
	],
	"events": [
		{
			"event_name": "purchase",
			"custom_name": null
		}
	],
	"status": "active"
}

​Endpoints

​Attributes

Endpoints

Attributes