Sign in
OpenAPI 3.1.02026-08-193894215.9 MB

23dfbe1a0d1f

Accounts

Update Account Preferences

Updates the account's preferences. Each top-level key present in the body is replaced as a whole; omitted keys are left untouched. ads_triple_whale_integration takes the Data-In API key to connect with, or null to disconnect. ads_payment_methods always requires a primary entry. backup is optional and any pairing is allowed — two cards, card+platform_balance, or a single method — so a card-only advertiser can fund ads without a platform balance. The primary and backup must be different sources. A platform_balance entry may omit id to use the account's default Whop balance. Configuring a card requires a user token; account API keys can set up platform-balance billing only.

patch/accounts/{account_id}/preferences

Request body

ads_reporting_currencystring

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

ads_scheduling_timezonestring

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.

cards_auto_top_upboolean

Whether incoming funds are automatically moved to the account's cards balance. Requires a cards balance on the account.

Example request

{
  "ads_payment_methods": {
    "backup": {
      "id": "payt_xxxxxxxxxxxxxx",
      "type": "card"
    },
    "primary": {
      "id": "payt_xxxxxxxxxxxxxx",
      "type": "platform_balance"
    }
  },
  "ads_reporting_currency": "eur",
  "ads_scheduling_timezone": "PST8PDT",
  "ads_triple_whale_integration": {
    "api_key": "tw_live_key_1234"
  },
  "cards_auto_top_up": true
}

Response

preferences updated

ads_reporting_currencystring required

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

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

cards_auto_top_upboolean required

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

Example response

{
  "ads_agreement": {
    "accepted_at": "2026-01-01T12:00:00.000Z",
    "agreement_version": "2026-01-01",
    "printed_name": "Marcus Webb",
    "status": "not_required"
  },
  "ads_payment_methods": {
    "backup": {
      "card_brand": "visa",
      "exp_month": 10,
      "exp_year": 2031,
      "icon_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "id": "ldgr_xxxxxxxxxxxxxx",
      "last4": "4242",
      "title": "Shine Time Auto Detailing",
      "type": "platform_balance"
    },
    "primary": {
      "card_brand": "visa",
      "exp_month": 10,
      "exp_year": 2031,
      "icon_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "id": "ldgr_xxxxxxxxxxxxxx",
      "last4": "4242",
      "title": "Shine Time Auto Detailing",
      "type": "platform_balance"
    }
  },
  "ads_reporting_currency": "usd",
  "ads_scheduling_timezone": "America/New_York",
  "ads_triple_whale_integration": {
    "masked_api_key": "tw_live_********",
    "shop_domain": "shinetime.myshopify.com",
    "status": "requires_shopify_store"
  }
}