Sign in
Accounts

Retrieve Account Preferences

Retrieves the account's preferences: a singleton settings document keyed by preference name.

get/accounts/{account_id}/preferences

Headers

Api-Version-Datestring
Example:2026-09-25

Pins the request to a dated API version.

Response

preferences retrieved

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.

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

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

economic_intelligenceboolean required

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

economic_intelligence_ends_atstring nullable required

When the account's committed Economic Intelligence period ends, as an ISO 8601 timestamp. Economic Intelligence can't be turned off before then. null when Economic Intelligence is off or has no end date.

economic_intelligence_fee_percentagenumber nullable required

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

subscription_failure_behavior'cancel' | 'none' required

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.

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_certifications": [
    {
      "business_type": "online_pharmacy",
      "certification_type": "prescription_drug_ads",
      "status": "not_started"
    }
  ],
  "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_shop_domain"
  },
  "cards_notifications": true,
  "economic_intelligence_offers": [
    {
      "duration": 7,
      "duration_unit": "days",
      "fee_percentage": 1,
      "key": "7_days"
    }
  ],
  "subscription_failure_behavior": "cancel"
}

Changes

Changed in 66 of the 74 revisions of this API.11160

  • 78e1ed7366cd2See the full diff
    • ○

      the security scope ad_campaign:create was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope company:update was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 73dd0533cd812See the full diff
    • ○

      the security scope ad_campaign:create was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope company:update was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 86b97292852d16See the full diff
    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ○

      the security scope ad_campaign:create was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope company:update was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

  • c1dceb26e5055See the full diff
    • ○

      the security scope ad_campaign:create was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope company:update was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

  • 7fcefabddb0a2See the full diff
    • ○

      the security scope ad_campaign:create was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope company:update was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 140d015b99662See the full diff
    • ○

      the security scope ad_campaign:create was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope company:update was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 35edb053220a2See the full diff
    • ○

      the security scope ad_campaign:create was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope company:update was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ac2b9b1c6a002See the full diff
    • ○

      the security scope ad_campaign:create was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope company:update was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • a88353507eac2See the full diff
    • ○

      the security scope ad_campaign:create was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope company:update was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 51933d70d7f52See the full diff
    • ○

      the security scope ad_campaign:create was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope company:update was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

Of the 74 revisions, 1 has no diff computed.