latestOpenAPI 3.1.02026-08-193894215.9 MB

23dfbe1a0d1f

Accounts

Account Updated

Sent when an account is updated

Required permissions:

  • webhook_receive:accounts
postWebhookaccount.updated

Headers

webhook-idstring required

A unique identifier for this webhook request

Example:msg_xxxxxxxxxxxxxxxxxxxxxxxx
webhook-signaturestring required

The signature of the webhook request with the webhook version prepended

Example:v1,BASE64ENCODEDSIGNATURE
webhook-timestampstring required

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

Example:1727606400

Payload

api_version'v1' required

The API version for this webhook

api_version_datestring nullable required

The dated API version (Api-Version-Date) the payload is serialized to

company_idstring nullable

The account ID that this webhook event is associated with

idstring required

A unique ID for every single webhook request

previous_attributesobject

For some .updated events, the old values of the payload fields that changed, keyed by field name. Omitted when no capture is available for the event

timestampstring date-time required

The timestamp in ISO 8601 format that the webhook was sent at on the server

type'account.updated' required

The webhook event type

Example payload

{
  "api_version": "v1",
  "api_version_date": "2026-07-20",
  "company_id": "biz_xxxxxxxxxxxxxx",
  "data": {
    "balances": [
      {
        "balance": "50.0",
        "breakdown": {
          "available": "1500.0",
          "in_transit": "0",
          "pending": "0",
          "pending_settlements": [
            {
              "amount": "12.5",
              "date": "2026-01-01"
            }
          ],
          "reserve": "0"
        },
        "icon_url": "https://assets.whop.com/tokens/usd.png",
        "name": "US Dollar",
        "price_usd": 1,
        "symbol": "USD",
        "value_usd": "50.00"
      }
    ],
    "banner_image_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "business_address": {
      "city": "Austin",
      "country": "US",
      "line1": "4180 Burnet Rd",
      "line2": "Suite 2",
      "postal_code": "78756",
      "state": "TX"
    },
    "business_name": "Shine Time Auto Detailing, LLC",
    "business_type": "other",
    "capabilities": {
      "accept_bank_payments": "active",
      "accept_bnpl_payments": "inactive",
      "accept_card_payments": "active",
      "bank_deposit": "inactive",
      "card_deposit": "active",
      "card_issuing": "inactive",
      "crypto_deposit": "active",
      "crypto_payout": "inactive",
      "instant_payout": "inactive",
      "run_ads": "active",
      "standard_payout": "inactive",
      "transfer": "inactive"
    },
    "cards": {
      "kind": "individual",
      "status": "approved"
    },
    "collect_vat_id": true,
    "company_formation": {
      "documents": [
        {
          "id": "file_xxxxxxxxxxxxxx",
          "name": "Articles of Organization",
          "type": "articles_of_organization",
          "url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ],
      "legal_name": "Shine Time Auto Detailing, LLC",
      "signatures": {
        "form8821": {
          "expires_at": "2026-01-01T12:00:00.000Z",
          "status": "pending",
          "url": "https://sign.doola.com/shine-time-auto-detailing/form8821"
        },
        "ss4": {
          "expires_at": "2026-01-01T12:00:00.000Z",
          "status": "pending",
          "url": "https://sign.doola.com/shine-time-auto-detailing/form8821"
        }
      },
      "state_registered": true
    },
    "country": "us",
    "created_at": "2026-01-01T12:00:00.000Z",
    "description": "Mobile ceramic coating, paint correction, and interior detailing across the Austin metro.",
    "email": "marcus@shinetime.example",
    "home_preferences": [
      "hide_member_count"
    ],
    "id": "biz_xxxxxxxxxxxxxx",
    "industry_group": "automotive",
    "industry_type": "other",
    "invoice_prefix": "SHINE",
    "logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "metadata": {
      "external_id": "shop_4417",
      "region": "austin"
    },
    "onboarding_type": "seller",
    "opengraph_image_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "opengraph_image_variant": "black",
    "other_business_description": "Mobile auto detailing",
    "other_industry_description": "Automotive services",
    "owner": {
      "id": "user_xxxxxxxxxxxxxx",
      "name": "Dana Whitfield",
      "profile_picture": {
        "url": "https://ui-avatars.com/api/"
      },
      "username": "danawhitfield"
    },
    "parent_account": {
      "id": "biz_xxxxxxxxxxxxxx",
      "logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "route": "shine-time-holdings",
      "title": "Shine Time Holdings"
    },
    "payment_controls": {
      "dispute_alert_auto_refund": {
        "threshold_usd": 500
      },
      "dispute_alert_fee_usd": 29,
      "pending_auto_topup_fee_percentage": 2,
      "reserve": {
        "hold_period_days": 14,
        "percentage": 15
      },
      "resolution_center_auto_refund": {
        "card_threshold_usd": 50,
        "financing_threshold_usd": 25,
        "paypal_threshold_usd": 40
      },
      "restricted_payment_methods": [
        "card_visa"
      ]
    },
    "product_tax_code": {
      "id": "ptc_xxxxxxxxxxxxxx",
      "name": "General - Digital Goods",
      "product_type": "digital"
    },
    "recommended_actions": [
      {
        "action": "apply_for_financing",
        "blocked_capabilities": [
          "accept_bnpl_payments"
        ],
        "cta": "https://whop.com/dashboard/biz_xxxxxxxxxxxxxx/settings/payments/",
        "cta_label": "Apply",
        "description": "Let customers pay over time with buy now, pay later.",
        "icon_url": "https://whop.com/illustrations/orange/piggy-bank.svg",
        "impact_score": 86,
        "reasoning": "Financing lifts conversion on the $249 ceramic coating, the priciest job on the menu.",
        "status": "optional",
        "title": "Offer financing at checkout"
      }
    ],
    "require_2fa": true,
    "required_actions": [
      {
        "action": "verify_identity",
        "blocked_capabilities": [
          "standard_payout"
        ],
        "cta": "https://whop.com/dashboard/biz_xxxxxxxxxxxxxx/balance/",
        "cta_label": "Verify now",
        "description": "Complete verification to withdraw your earnings.",
        "icon_url": "https://whop.com/illustrations/orange/shield.svg",
        "status": "required",
        "title": "Complete your identity verification"
      }
    ],
    "route": "biz_xxxxxxxxxxxxxx",
    "social_links": [
      {
        "id": "social_1",
        "title": "@shinetimedetail",
        "url": "https://instagram.com/shinetimedetail",
        "website": "instagram"
      }
    ],
    "status": "active",
    "status_reason": "Payments are paused while we review recent chargebacks on this account.",
    "store_page_config": {
      "accent_color": "red",
      "layout": "compact",
      "profile_variant": "business",
      "whop_affiliate_link": true
    },
    "target_audience": "Owners of new and enthusiast vehicles in Austin, TX",
    "tax_collection_enabled_states": [
      "TX"
    ],
    "tax_identifiers": [
      {
        "id": "txid_xxxxxxxxxxxxxx",
        "tax_id_type": "eu_vat",
        "tax_id_value": "DE123456789"
      }
    ],
    "tax_remitted_by": "self",
    "tax_type": "inclusive",
    "three_ds_level": "mandate_challenge",
    "title": "Shine Time Auto Detailing",
    "total_usd": "50.00",
    "use_logo_as_opengraph_image_fallback": true,
    "verification": {
      "business": null,
      "individual": null
    },
    "wallet": {
      "address": "0xabc123",
      "id": "cwal_xxxxxxxxxxxxxx",
      "network": "ethereum"
    }
  },
  "id": "msg_xxxxxxxxxxxxxxxxxxxxxxxx",
  "previous_attributes": {
    "title": "Webb's Mobile Detailing"
  },
  "timestamp": "2025-01-01T00:00:00.000Z",
  "type": "account.updated"
}

Response

Return a 200 status to indicate that the data was received successfully