Skip to main content
GET
TypeScript

Autorisations

Authorization
string
header
requis

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.

Scopes

ad_campaign:create
payout:account:update
payment:dispute
company:update

En-têtes

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

account_id
string
requis

Account ID, prefixed biz_.

Réponse

preferences retrieved

ads_agreement
object
requis

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_payment_methods
object | null
requis

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
requis

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

Exemple:

"usd"

ads_scheduling_timezone
string
requis

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.

Exemple:

"America/New_York"

ads_triple_whale_integration
object
requis

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.

cancellation_emails
boolean
requis

Whether Whop emails members when their membership is canceled or terminated. true by default. Set it to false to stop these emails while keeping the account's other customer emails. They also stop while the account's send_customer_emails is false.

Exemple:

true

cards_auto_top_up
boolean
requis

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

Exemple:

false

cards_notifications
boolean
requis

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.

Exemple:

true

covers_subaccount_negative_balances
boolean | null
requis

Whether this account covers its subaccounts' negative balances. When a subaccount's balance drops below zero (from refunds, disputes, or fees), this account's available balance in the same currency pays it back, up to what is available. Refunds on its subaccounts may also take them negative by up to this account's available balance. null when the account has no subaccounts.

Exemple:

null

customer_tracking
object | null
requis

The saved customer tracking settings for the hosted tracking page and Element, with defaults applied. null until set; tracking is off unless enabled is true.

dispute_fighter_enabled
boolean
requis

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.

Exemple:

false

economic_intelligence
boolean
requis

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

Exemple:

false

economic_intelligence_auto_renew
boolean
requis

Whether Economic Intelligence renews itself every period, with no end date. Turn it on by setting this to true, or by passing the 3_days offer's key as economic_intelligence_duration_key. Set it to false to stop renewing: Economic Intelligence stays on until the end of the current period, shown in economic_intelligence_ends_at, and the fee is charged until then. Set it back to true before then to keep renewing.

Exemple:

false

economic_intelligence_ends_at
string | null
requis

When Economic Intelligence turns off, as an ISO 8601 timestamp: the end of the current period once auto-renew is turned off. null when Economic Intelligence is off or renews automatically.

Exemple:

null

economic_intelligence_fee_percentage
number | null
requis

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

Exemple:

null

economic_intelligence_first_renewal_at
string | null
requis

When auto-renew first renews, as an ISO 8601 timestamp: one period after it was turned on. null when auto-renew is off.

Exemple:

null

economic_intelligence_offers
object[]
requis

What the account can choose now to turn on Economic Intelligence. Auto-renew is the only plan: one offer, with its fee and the length of each period, while auto-renew is off, and empty while Economic Intelligence renews automatically.

economic_intelligence_previous_period
object | null
requis

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

failed_payment_emails
boolean
requis

Whether Whop emails members when a renewal payment fails or needs them to verify it. true by default. Set it to false to stop these emails while keeping the account's other customer emails. Subscriptions billed by invoice still get the invoice and its past-due reminders, since that is how the member pays. These emails also stop while the account's send_customer_emails is false.

Exemple:

true

feedback_options
object[]
requis

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.

merchant_of_record
enum<string> | null
requis

The merchant of record for the account's payments. whop means Whop is the merchant of record and the account can switch. null means Whop is the merchant of record and the account's business category cannot switch. pending means the account switched and waits for approval. Checkout takes no payments until then. account means the account is the merchant of record.

Options disponibles:
whop,
pending,
account,
null
Exemple:

"whop"

preferred_settlement_currency
enum<string> | null
requis

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.

Options disponibles:
usd,
eur,
gbp,
cad,
aud,
null
Exemple:

"usd"

preferred_settlement_currency_changeable_at
string | null
requis

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

Exemple:

null

renewal_reminder_emails
boolean
requis

Whether Whop emails members the day before their membership renews or their free trial converts. true by default. Set it to false to stop that reminder. Members still get the reminders card networks require. They go out 7 days before a trial over 7 days converts, and 30 days before a 6-month or longer plan renews. All stop while send_customer_emails is false.

Exemple:

true

review_request_emails
boolean
requis

Whether Whop emails customers after a purchase asking them to leave a review. true by default. Set it to false to stop these emails, including ones already scheduled. They also stop while the account's send_customer_emails is false.

Exemple:

true

subaccount_notifications
boolean | null
requis

Whether Whop emails and notifies the teams of this account's subaccounts. true by default. Set it to false to stop Whop's emails, push, and in-app notifications to them. These include payout, verification, dispute, and card alerts about their accounts. null when the account has no subaccounts.

Exemple:

null

subaccount_team_view_only
boolean | null
requis

Whether this account's subaccounts are view-only for their own team members. When true, a subaccount's team can still see everything their role allows but every change is refused with a view-only error. false by default. null when the account has no subaccounts.

Exemple:

null

subscription_failure_behavior
enum<string>
requis

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.

Options disponibles:
cancel,
none
Exemple:

"cancel"