Retrieve Account Preferences
Retrieves the account’s preferences: a singleton settings document keyed by preference name.
인증
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.
응답
preferences retrieved
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.
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.
true
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.
null
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.
false
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.
true
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.
whop, pending, account, null "whop"
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.
usd, eur, gbp, cad, aud, null "usd"
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.
true
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.
null
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.
null
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.
cancel, none "cancel"

