Skip to main content
PATCH
TypeScript

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-15-1"

Path Parameters

account_id
string
required

Account ID, prefixed biz_.

Body

application/json
ads_certifications
object

Opens an advertising certification application. Keyed by certification type (prescription_drug_ads); set the entry's status to pending_information to start, then answer the requested fields via PATCH /verifications/{id}. Only one application per type can be open at a time; every other status is set by Whop's review. Requires the ad_campaign:create scope on your API key.

Example:
ads_payment_methods
object

How the account pays for Whop Ads spend. Requires primary; backup is optional and covers the charge when the primary fails. Requires the ad_campaign:create scope on your API key. Configuring a card requires a user token; account API keys can configure only platform_balance sources.

ads_reporting_currency
string

Lowercase ISO currency code, such as usd or eur, used to display ad spend and stats. Defaults to usd. Requires the ad_campaign:create scope on your API key.

Example:

"eur"

ads_scheduling_timezone
string

IANA timezone (e.g. America/New_York) used to interpret campaign start/end times and to bucket reports. Cannot be cleared once set — pass a new value to change it. Requires the ad_campaign:create scope on your API key.

Example:

"PST8PDT"

ads_triple_whale_integration
object

Connects or disconnects the Triple Whale integration, or changes the shop it reports to. Requires the ad_campaign:create scope on your API key. Connecting requires a shop_domain to report spend against.

cards_auto_top_up
boolean

Whether incoming funds are automatically moved to the account's cards balance. Requires a cards balance on the account and the payout:account:update scope on your API key.

Example:

true

cards_notifications
boolean

Whether Whop Card notifications reach this account's team. Set it to false to stop every card email and push notification for the account — application status, verification and action-required alerts, card-ready alerts, declines, large charges, and cashback summaries. Cardholder onboarding invitations still send, because they carry the only link an invited cardholder can onboard with. Requesting a card is rejected while notifications are off, since the request reaches nobody. Cards on personal accounts are unaffected. Requires a cards balance on the account and the payout:account:update scope on your API key.

Example:

true

dispute_fighter_enabled
boolean

Whether Whop assembles and files the evidence response when this account's payments are disputed. Off by default; enabling it also opts the account into the success fee charged only on disputes it wins. Requires the payment:dispute scope on your API key.

Example:

true

economic_intelligence_auto_renew
boolean

false stops renewing: Economic Intelligence stays on until the end of the current week, and stopping before the first renewal charges the rest of that week at the 7_days offer's fee. true keeps it renewing again before then, or turns it on like the weekly offer. Can't be combined with economic_intelligence_duration_key. Requires the company:update scope on your API key.

Example:

false

economic_intelligence_duration_key
enum<string>

Turns on Economic Intelligence with the offer that has this key in economic_intelligence_offers, at that offer's fee. A committed duration can't be changed or turned off until economic_intelligence_ends_at, except to upgrade to weekly, which switches to auto-renew right away. Requires the company:update scope on your API key.

Available options:
weekly,
7_days,
1_day,
1_hour
Example:

"weekly"

feedback_options
object[]

Replaces the account's own cancel reasons, shown to members in this order when they cancel. Pass an option's id to keep it, for example when renaming it; options without an id are added, and options left out are removed. Pass an empty array to go back to Whop's default reasons. Members who already picked an option keep the label they saw. Requires the company:manage_checkout scope on your API key.

Maximum array length: 10
preferred_settlement_currency
enum<string> | null

Settle every new sale into this currency, regardless of the plan's currency or what the buyer paid in; sales converted this way carry an additional 0.5% FX fee. Pass null to go back to settling each sale in its plan's currency. Changing it never converts money already in your balances, and it can change at most once every 7 days (see preferred_settlement_currency_changeable_at). Requires the payout:account:update scope on your API key.

Available options:
usd,
eur,
gbp,
cad,
aud,
null
Example:

"eur"

subscription_failure_behavior
enum<string>

What happens to a subscription once every retry of a renewal payment has failed. cancel (the default) cancels it. none leaves it past due and keeps billing it each period; access follows the account's past-due access setting. Requires company:manage_checkout permission.

Available options:
cancel,
none
Example:

"none"

Response

preferences updated

ads_agreement
object
required

The account's Whop Ads services and payment authorization agreement. While pending_signature, campaign launch is blocked; sign by answering requested_information via PATCH /verifications/{id}.

ads_certifications
object[]
required

The account's advertising certifications, one entry per certification type Whop offers. Start an application by setting a type's status to pending_information via PATCH, then answer the fields it requests via GET/PATCH /verifications/{id}.

ads_payment_methods
object | null
required

How the account pays for Whop Ads spend. primary is charged first; backup covers the charge when the primary fails. null until ads billing has been configured.

ads_reporting_currency
string
required

Lowercase ISO currency code, such as usd or eur, used to display ad spend and stats. Defaults to usd.

Example:

"usd"

ads_scheduling_timezone
string
required

IANA timezone (e.g. America/New_York) used to interpret campaign start/end times and to bucket reports. Defaults to America/New_York until explicitly overridden.

Example:

"America/New_York"

ads_triple_whale_integration
object
required

The account's Triple Whale integration, which pushes Whop ad spend to Triple Whale's Data-In API so it reports as a whop channel. Available to any Triple Whale customer — Shopify, WooCommerce, or a custom checkout — by setting shop_domain. Requires the ad_campaign:create scope. Once connected, ad click-through URLs Whop serves carry tw_source=whop and tw_adid=<ad id> query parameters so Triple Whale's pixel attributes conversions back to the originating ad — no destination URL changes are needed.

cards_auto_top_up
boolean
required

Whether incoming funds are automatically moved to the account's cards balance. false when the account has no cards balance.

Example:

false

cards_notifications
boolean
required

Whether Whop Card notifications reach this account's team. true by default, including when the account has no cards balance. Set it to false to stop every card email and push notification for the account — application status, verification and action-required alerts, card-ready alerts, declines, large charges, and cashback summaries. Cardholder onboarding invitations still send, because they carry the only link an invited cardholder can onboard with. Requesting a card is rejected while notifications are off, since the request reaches nobody. Cards on personal accounts are unaffected.

Example:

true

dispute_fighter_enabled
boolean
required

Whether Whop assembles and files the evidence response when this account's payments are disputed. Off by default; enabling it also opts the account into the success fee charged only on disputes it wins.

Example:

false

economic_intelligence
boolean
required

Whether Economic Intelligence is on for the account. It turns off automatically at economic_intelligence_ends_at.

Example:

false

economic_intelligence_auto_renew
boolean
required

Whether Economic Intelligence renews itself every week, with no end date. Turn it on with the weekly offer. Set it to false to stop renewing, which keeps Economic Intelligence on until the end of the current week, shown in economic_intelligence_ends_at; stopping before the first renewal charges the rest of that week at the 7_days offer's fee. Set it back to true before then to keep renewing at the weekly fee.

Example:

false

economic_intelligence_ends_at
string | null
required

When the account's committed Economic Intelligence period ends, as an ISO 8601 timestamp. Economic Intelligence can't be turned off before then. null when Economic Intelligence is off or renews automatically.

Example:

"2026-01-01T12:00:00.000Z"

economic_intelligence_fee_percentage
number | null
required

Percentage of volume charged while Economic Intelligence is on, such as 1.5 for 1.5%. null when Economic Intelligence is off.

Example:

1.5

economic_intelligence_first_renewal_at
string | null
required

When auto-renew first renews, as an ISO 8601 timestamp. Turning auto-renew off before then charges the rest of that week at the 7_days offer's fee. null when auto-renew is off.

Example:

null

economic_intelligence_offers
object[]
required

What the account can choose now to turn on Economic Intelligence, each with its fee. Every offer while Economic Intelligence is off; only the weekly auto-renew offer while a committed period is running, as an upgrade; empty while it renews automatically.

economic_intelligence_previous_period
object | null
required

The account's last Economic Intelligence period, once it has ended. null while Economic Intelligence is on, or when it has never been on.

feedback_options
object[]
required

The account's own cancel reasons, in the order members see them when they cancel. Each is filed under a standard category, saved as the membership's cancel_option, so reports keep grouping cancellations. Empty when the account uses Whop's default reasons.

preferred_settlement_currency
enum<string> | null
required

Lowercase ISO currency code every new sale settles into, regardless of the plan's currency or what the buyer paid in. Sales converted this way carry an additional 0.5% FX fee. null when the account settles each sale in its plan's currency.

Available options:
usd,
eur,
gbp,
cad,
aud,
null
Example:

"eur"

preferred_settlement_currency_changeable_at
string | null
required

When preferred_settlement_currency may next be changed or turned off, as an ISO 8601 timestamp. It can change at most once every 7 days. null when it may change now.

Example:

"2026-01-01T12:00:00.000Z"

subscription_failure_behavior
enum<string>
required

What happens to a subscription once every retry of a renewal payment has failed. cancel (the default) cancels it. none leaves it past due and keeps billing it each period; access follows the account's past-due access setting.

Available options:
cancel,
none
Example:

"cancel"