TypeScript
import { WhopClient } from "@whop/sdk";
const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.accounts.list();curl --request GET \
--url https://api.whop.com/api/v1/accounts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.whop.com/api/v1/accounts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.whop.com/api/v1/accounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.whop.com/api/v1/accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.whop.com/api/v1/accounts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.whop.com/api/v1/accounts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.whop.com/api/v1/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"ads_spend_usd": 0,
"balances": [
{
"balance": "1500.0",
"breakdown": {
"available": "1500.0",
"finishing_settlement": "0",
"in_transit": "0",
"pending": "0",
"pending_settlements": [
{
"amount": "0.0",
"date": "2026-01-01"
}
],
"reserve": "0"
},
"icon_url": "https://assets.whop.com/tokens/usdt.png",
"name": "Tether USD",
"price_usd": 1,
"symbol": "USDT",
"value_usd": "1500.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": "software",
"can_transfer_pending_balance_to_children": false,
"cancellation_policy": {
"blurhash": null,
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"duration_seconds": null,
"filename": "evidence.pdf",
"height": null,
"id": "file_xxxxxxxxxxxxxx",
"object": "file",
"removed_by_moderation": false,
"size": 9670,
"upload_status": "pending",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private",
"waveform_url": null,
"width": null,
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"upload_headers": {},
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
},
"capabilities": {
"accept_bank_payments": "active",
"accept_bnpl_payments": "inactive",
"accept_card_payments": "active",
"bank_deposit": "inactive",
"card_deposit": "inactive",
"card_issuing": "inactive",
"crypto_deposit": "active",
"crypto_payout": "inactive",
"instant_payout": "inactive",
"run_ads": "inactive",
"standard_payout": "inactive",
"transfer": "inactive"
},
"cards": {
"kind": "individual",
"status": "approved"
},
"collect_vat_id": false,
"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"
}
],
"ein_registered": false,
"legal_name": "Shine Time Auto Detailing, LLC",
"signatures": {
"form8821": {
"status": "pending",
"expires_at": "2026-01-01T12:00:00.000Z",
"url": "https://sign.doola.com/shine-time-auto-detailing/form8821"
},
"ss4": {
"status": "pending",
"expires_at": "2026-01-01T12:00:00.000Z",
"url": "https://sign.doola.com/shine-time-auto-detailing/form8821"
}
},
"state_registered": true,
"status": "draft"
},
"country": "us",
"created_at": "2026-01-01T12:00:00.000Z",
"customers_l30d": null,
"description": "Mobile ceramic coating, paint correction, and interior detailing across the Austin metro.",
"dispute_fighter_enabled": false,
"economic_intelligence": false,
"email": "marcus@shinetime.example",
"eula": {
"blurhash": null,
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"duration_seconds": null,
"filename": "evidence.pdf",
"height": null,
"id": "file_xxxxxxxxxxxxxx",
"object": "file",
"removed_by_moderation": false,
"size": 9670,
"upload_status": "pending",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private",
"waveform_url": null,
"width": null,
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"upload_headers": {},
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
},
"financing": {
"application_id": "inrq_xxxxxxxxxxxxxx",
"status": "awaiting_review"
},
"home_preferences": [
"hide_member_count"
],
"id": "biz_xxxxxxxxxxxxxx",
"industry_type": "trading",
"invoice_prefix": "INV",
"level": {
"boosted": true,
"current": 1,
"levels": [
{
"level": 0,
"minimum_spend": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"processing_rate_percentage": 2.7,
"regional_rates": [
{
"processing_rate_percentage": 1.7,
"region": "europe_uk_and_australia"
}
]
}
],
"monthly_ads_spend": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"monthly_card_spend": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"monthly_qualifying_spend": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"monthly_trading_volume": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"points": 41000,
"points_by_source": {
"ads": 0,
"cards": 40000,
"trading": 1000
},
"points_to_next": 59000,
"processing_rate_percentage": 2.6,
"resets_at": "2026-01-01T12:00:00.000Z"
},
"logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"metadata": {
"external_id": "connected_account_123"
},
"onboarding_type": "platform",
"opengraph_image_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"opengraph_image_variant": "black",
"orchestration_enabled": true,
"other_business_description": null,
"other_industry_description": null,
"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",
"fees": {
"crypto_swap_markup": {
"fixed_fee_usd": 0,
"percentage_fee": 3
},
"transfer_markup": {
"fixed_fee_usd": 0,
"percentage_fee": 0
}
}
},
"payment_controls": {
"dispute_alert_auto_refund": {
"locked": false,
"threshold_usd": 500
},
"dispute_alert_fee_usd": 29,
"enforce_3ds": false,
"financing_disabled": false,
"high_risk_processing_fee_percentage": 0,
"pending_auto_topup_fee_percentage": 2,
"pending_balance_delay_days": 0,
"reserve": {
"hold_period_days": 14,
"percentage": 15
},
"resolution_center_auto_refund": {
"card_threshold_usd": 50,
"financing_threshold_usd": 25,
"locked": false,
"paypal_threshold_usd": 40
},
"restricted_payment_methods": [
"card_visa"
],
"undated_pending_reason": "pending_information_request",
"withdrawal_schedule": {
"day": null,
"frequency": "manual",
"next_payout_date": null
}
},
"platform_credits": [
{
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
}
],
"privacy_policy": {
"blurhash": null,
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"duration_seconds": null,
"filename": "evidence.pdf",
"height": null,
"id": "file_xxxxxxxxxxxxxx",
"object": "file",
"removed_by_moderation": false,
"size": 9670,
"upload_status": "pending",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private",
"waveform_url": null,
"width": null,
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"upload_headers": {},
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
},
"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": false,
"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"
}
],
"return_policy": {
"blurhash": null,
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"duration_seconds": null,
"filename": "evidence.pdf",
"height": null,
"id": "file_xxxxxxxxxxxxxx",
"object": "file",
"removed_by_moderation": false,
"size": 9670,
"upload_status": "pending",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private",
"waveform_url": null,
"width": null,
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"upload_headers": {},
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
},
"route": "biz_xxxxxxxxxxxxxx",
"send_customer_emails": false,
"shipping_policy": {
"blurhash": null,
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"duration_seconds": null,
"filename": "evidence.pdf",
"height": null,
"id": "file_xxxxxxxxxxxxxx",
"object": "file",
"removed_by_moderation": false,
"size": 9670,
"upload_status": "pending",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private",
"waveform_url": null,
"width": null,
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"upload_headers": {},
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
},
"show_joined_whops": true,
"show_reviews_dtc": true,
"show_user_directory": true,
"social_links": [
{
"id": "social_1",
"title": "@shinetimedetail",
"url": "https://instagram.com/shinetimedetail",
"website": "instagram"
}
],
"status": "active",
"status_reason": "Suspended - Fraudulent activity",
"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",
"terms_of_service": {
"blurhash": null,
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"duration_seconds": null,
"filename": "evidence.pdf",
"height": null,
"id": "file_xxxxxxxxxxxxxx",
"object": "file",
"removed_by_moderation": false,
"size": 9670,
"upload_status": "pending",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private",
"waveform_url": null,
"width": null,
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"upload_headers": {},
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
},
"three_ds_level": "mandate_challenge",
"title": "Shine Time Auto Detailing",
"total_earned_usd": 0,
"total_usd": "50.00",
"trading": {
"account_id": "<string>",
"hyperliquid": {
"address": "<string>",
"websocket_subscriptions": [
{
"channel": "clearinghouse_state",
"message": "<string>"
}
],
"websocket_url": "<string>"
},
"id": "<string>",
"object": "trading_account",
"provider": "hyperliquid",
"user_id": "<string>"
},
"use_logo_as_opengraph_image_fallback": false,
"verification": {
"business": null,
"individual": null
},
"volume_l30d_usd": 0,
"volume_usd": 123,
"wallet": {
"address": "0xabc123",
"id": "cwal_xxxxxxxxxxxxxx",
"network": "ethereum"
},
"website": "https://shinetimedetail.com",
"direct_reports_count": 0,
"partner": {
"email": "<string>",
"id": "<string>",
"name": "<string>",
"profile_picture": {
"url": "https://ui-avatars.com/api/"
},
"username": "<string>",
"whop_partner_verified_at": "<string>"
},
"rewards": [
{
"id": "<string>",
"qualification_amount": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"qualification_progress": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"qualification_type": "sales",
"reward_amount": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"status": "in_progress"
}
],
"whop_partner_enabled_at": null
}
],
"page_info": {
"end_cursor": null,
"has_next_page": false,
"has_previous_page": false,
"start_cursor": "WyJjdXJzb3IiLDFd"
}
}{
"error": {
"message": "account_id is required",
"type": "bad_request",
"code": "<string>"
}
}{
"error": {
"message": "account_id is required",
"type": "bad_request",
"code": "<string>"
}
}{
"error": {
"message": "account_id is required",
"type": "bad_request",
"code": "<string>"
}
}Accounts
List Accounts
Lists accounts visible to the credential. User tokens return the user’s business accounts; Account API keys return the requesting account and its connected accounts.
GET
/
accounts
TypeScript
import { WhopClient } from "@whop/sdk";
const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.accounts.list();curl --request GET \
--url https://api.whop.com/api/v1/accounts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.whop.com/api/v1/accounts"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.whop.com/api/v1/accounts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.whop.com/api/v1/accounts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.whop.com/api/v1/accounts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.whop.com/api/v1/accounts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.whop.com/api/v1/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"ads_spend_usd": 0,
"balances": [
{
"balance": "1500.0",
"breakdown": {
"available": "1500.0",
"finishing_settlement": "0",
"in_transit": "0",
"pending": "0",
"pending_settlements": [
{
"amount": "0.0",
"date": "2026-01-01"
}
],
"reserve": "0"
},
"icon_url": "https://assets.whop.com/tokens/usdt.png",
"name": "Tether USD",
"price_usd": 1,
"symbol": "USDT",
"value_usd": "1500.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": "software",
"can_transfer_pending_balance_to_children": false,
"cancellation_policy": {
"blurhash": null,
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"duration_seconds": null,
"filename": "evidence.pdf",
"height": null,
"id": "file_xxxxxxxxxxxxxx",
"object": "file",
"removed_by_moderation": false,
"size": 9670,
"upload_status": "pending",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private",
"waveform_url": null,
"width": null,
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"upload_headers": {},
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
},
"capabilities": {
"accept_bank_payments": "active",
"accept_bnpl_payments": "inactive",
"accept_card_payments": "active",
"bank_deposit": "inactive",
"card_deposit": "inactive",
"card_issuing": "inactive",
"crypto_deposit": "active",
"crypto_payout": "inactive",
"instant_payout": "inactive",
"run_ads": "inactive",
"standard_payout": "inactive",
"transfer": "inactive"
},
"cards": {
"kind": "individual",
"status": "approved"
},
"collect_vat_id": false,
"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"
}
],
"ein_registered": false,
"legal_name": "Shine Time Auto Detailing, LLC",
"signatures": {
"form8821": {
"status": "pending",
"expires_at": "2026-01-01T12:00:00.000Z",
"url": "https://sign.doola.com/shine-time-auto-detailing/form8821"
},
"ss4": {
"status": "pending",
"expires_at": "2026-01-01T12:00:00.000Z",
"url": "https://sign.doola.com/shine-time-auto-detailing/form8821"
}
},
"state_registered": true,
"status": "draft"
},
"country": "us",
"created_at": "2026-01-01T12:00:00.000Z",
"customers_l30d": null,
"description": "Mobile ceramic coating, paint correction, and interior detailing across the Austin metro.",
"dispute_fighter_enabled": false,
"economic_intelligence": false,
"email": "marcus@shinetime.example",
"eula": {
"blurhash": null,
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"duration_seconds": null,
"filename": "evidence.pdf",
"height": null,
"id": "file_xxxxxxxxxxxxxx",
"object": "file",
"removed_by_moderation": false,
"size": 9670,
"upload_status": "pending",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private",
"waveform_url": null,
"width": null,
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"upload_headers": {},
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
},
"financing": {
"application_id": "inrq_xxxxxxxxxxxxxx",
"status": "awaiting_review"
},
"home_preferences": [
"hide_member_count"
],
"id": "biz_xxxxxxxxxxxxxx",
"industry_type": "trading",
"invoice_prefix": "INV",
"level": {
"boosted": true,
"current": 1,
"levels": [
{
"level": 0,
"minimum_spend": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"processing_rate_percentage": 2.7,
"regional_rates": [
{
"processing_rate_percentage": 1.7,
"region": "europe_uk_and_australia"
}
]
}
],
"monthly_ads_spend": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"monthly_card_spend": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"monthly_qualifying_spend": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"monthly_trading_volume": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"points": 41000,
"points_by_source": {
"ads": 0,
"cards": 40000,
"trading": 1000
},
"points_to_next": 59000,
"processing_rate_percentage": 2.6,
"resets_at": "2026-01-01T12:00:00.000Z"
},
"logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"metadata": {
"external_id": "connected_account_123"
},
"onboarding_type": "platform",
"opengraph_image_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"opengraph_image_variant": "black",
"orchestration_enabled": true,
"other_business_description": null,
"other_industry_description": null,
"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",
"fees": {
"crypto_swap_markup": {
"fixed_fee_usd": 0,
"percentage_fee": 3
},
"transfer_markup": {
"fixed_fee_usd": 0,
"percentage_fee": 0
}
}
},
"payment_controls": {
"dispute_alert_auto_refund": {
"locked": false,
"threshold_usd": 500
},
"dispute_alert_fee_usd": 29,
"enforce_3ds": false,
"financing_disabled": false,
"high_risk_processing_fee_percentage": 0,
"pending_auto_topup_fee_percentage": 2,
"pending_balance_delay_days": 0,
"reserve": {
"hold_period_days": 14,
"percentage": 15
},
"resolution_center_auto_refund": {
"card_threshold_usd": 50,
"financing_threshold_usd": 25,
"locked": false,
"paypal_threshold_usd": 40
},
"restricted_payment_methods": [
"card_visa"
],
"undated_pending_reason": "pending_information_request",
"withdrawal_schedule": {
"day": null,
"frequency": "manual",
"next_payout_date": null
}
},
"platform_credits": [
{
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
}
],
"privacy_policy": {
"blurhash": null,
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"duration_seconds": null,
"filename": "evidence.pdf",
"height": null,
"id": "file_xxxxxxxxxxxxxx",
"object": "file",
"removed_by_moderation": false,
"size": 9670,
"upload_status": "pending",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private",
"waveform_url": null,
"width": null,
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"upload_headers": {},
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
},
"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": false,
"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"
}
],
"return_policy": {
"blurhash": null,
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"duration_seconds": null,
"filename": "evidence.pdf",
"height": null,
"id": "file_xxxxxxxxxxxxxx",
"object": "file",
"removed_by_moderation": false,
"size": 9670,
"upload_status": "pending",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private",
"waveform_url": null,
"width": null,
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"upload_headers": {},
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
},
"route": "biz_xxxxxxxxxxxxxx",
"send_customer_emails": false,
"shipping_policy": {
"blurhash": null,
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"duration_seconds": null,
"filename": "evidence.pdf",
"height": null,
"id": "file_xxxxxxxxxxxxxx",
"object": "file",
"removed_by_moderation": false,
"size": 9670,
"upload_status": "pending",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private",
"waveform_url": null,
"width": null,
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"upload_headers": {},
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
},
"show_joined_whops": true,
"show_reviews_dtc": true,
"show_user_directory": true,
"social_links": [
{
"id": "social_1",
"title": "@shinetimedetail",
"url": "https://instagram.com/shinetimedetail",
"website": "instagram"
}
],
"status": "active",
"status_reason": "Suspended - Fraudulent activity",
"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",
"terms_of_service": {
"blurhash": null,
"content_type": "application/pdf",
"created_at": "2026-01-01T12:00:00.000Z",
"duration_seconds": null,
"filename": "evidence.pdf",
"height": null,
"id": "file_xxxxxxxxxxxxxx",
"object": "file",
"removed_by_moderation": false,
"size": 9670,
"upload_status": "pending",
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/audio/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"visibility": "private",
"waveform_url": null,
"width": null,
"multipart_chunk_size": 5242880,
"multipart_upload_id": "upload-id",
"multipart_upload_urls": [
{
"part_number": 1,
"url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
}
],
"upload_headers": {},
"upload_url": "https://whop-assets-example.s3.amazonaws.com/uploads/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/application.pdf"
},
"three_ds_level": "mandate_challenge",
"title": "Shine Time Auto Detailing",
"total_earned_usd": 0,
"total_usd": "50.00",
"trading": {
"account_id": "<string>",
"hyperliquid": {
"address": "<string>",
"websocket_subscriptions": [
{
"channel": "clearinghouse_state",
"message": "<string>"
}
],
"websocket_url": "<string>"
},
"id": "<string>",
"object": "trading_account",
"provider": "hyperliquid",
"user_id": "<string>"
},
"use_logo_as_opengraph_image_fallback": false,
"verification": {
"business": null,
"individual": null
},
"volume_l30d_usd": 0,
"volume_usd": 123,
"wallet": {
"address": "0xabc123",
"id": "cwal_xxxxxxxxxxxxxx",
"network": "ethereum"
},
"website": "https://shinetimedetail.com",
"direct_reports_count": 0,
"partner": {
"email": "<string>",
"id": "<string>",
"name": "<string>",
"profile_picture": {
"url": "https://ui-avatars.com/api/"
},
"username": "<string>",
"whop_partner_verified_at": "<string>"
},
"rewards": [
{
"id": "<string>",
"qualification_amount": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"qualification_progress": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"qualification_type": "sales",
"reward_amount": {
"amount": "-1234.56",
"currency": "usd",
"decimals": 2,
"display_decimals": 2
},
"status": "in_progress"
}
],
"whop_partner_enabled_at": null
}
],
"page_info": {
"end_cursor": null,
"has_next_page": false,
"has_previous_page": false,
"start_cursor": "WyJjdXJzb3IiLDFd"
}
}{
"error": {
"message": "account_id is required",
"type": "bad_request",
"code": "<string>"
}
}{
"error": {
"message": "account_id is required",
"type": "bad_request",
"code": "<string>"
}
}{
"error": {
"message": "account_id is required",
"type": "bad_request",
"code": "<string>"
}
}Authorizations
accountApiKeyOrAccountTokenOrAccountUserTokenOrOauthTokenAuthaccountApiKeyOrAccountTokenOrAccountUserTokenOrOauthTokenAuth
An Account 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.
Headers
Pins the request to a dated API version.
Example:
"2026-10-29-8"
Query Parameters
Number of results to return from the start of the range.
Required range:
x <= 50Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.
Number of results to return from the end of the range.
Required range:
x <= 50Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.
The field to sort accounts by. volume requires stats:read on the parent account.
Available options:
created_at, volume Sort direction.
Available options:
asc, desc Return only accounts with this status: active (includes accounts that have not entered payments review) or suspended.
Available options:
active, suspended Free-text filter on account title or ID. % and _ match literally.
Return only accounts created after this ISO 8601 timestamp.
Return only accounts created before this ISO 8601 timestamp.
Return only accounts whose lifetime USD volume is at least this value. Requires stats:read on the parent account.
Return only accounts whose lifetime USD volume is at most this value. Requires stats:read on the parent account.
For platforms: the parent account ID whose direct connected accounts to return. Requires payout:account:read on the parent account.
Return only accounts owned by this user (user_...), the account's owner. Cannot be combined with parent_account_id.