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/{account_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.

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.

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.