Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Path Parameters

account_id
string
required

Account ID, prefixed biz_.

Response

preferences retrieved

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_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.

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