@whop/cli 0.14.1 → 0.14.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/README.md +3 -3
  2. package/dist/index.js +22283 -7154
  3. package/dist/index.js.map +1 -1
  4. package/package.json +1 -1
  5. package/skills/whop-accounts/SKILL.md +195 -15
  6. package/skills/whop-ad-campaigns/SKILL.md +193 -15
  7. package/skills/whop-ad-groups/SKILL.md +258 -16
  8. package/skills/whop-ads/SKILL.md +190 -14
  9. package/skills/whop-api-keys/SKILL.md +113 -13
  10. package/skills/whop-app-builds/SKILL.md +68 -8
  11. package/skills/whop-apps/SKILL.md +135 -12
  12. package/skills/whop-audiences/SKILL.md +92 -8
  13. package/skills/whop-bounties/SKILL.md +104 -9
  14. package/skills/whop-bounty-submissions/SKILL.md +82 -9
  15. package/skills/whop-cards/SKILL.md +122 -12
  16. package/skills/whop-checkout-configurations/SKILL.md +64 -8
  17. package/skills/whop-deposits/SKILL.md +13 -5
  18. package/skills/whop-disputes/SKILL.md +86 -9
  19. package/skills/whop-events/SKILL.md +90 -8
  20. package/skills/whop-exports/SKILL.md +331 -7
  21. package/skills/whop-ledgers/SKILL.md +38 -6
  22. package/skills/whop-media/SKILL.md +28 -7
  23. package/skills/whop-members/SKILL.md +51 -6
  24. package/skills/whop-memberships/SKILL.md +137 -13
  25. package/skills/whop-notifications/SKILL.md +91 -12
  26. package/skills/whop-partners/SKILL.md +102 -12
  27. package/skills/whop-payments/SKILL.md +40 -0
  28. package/skills/whop-payouts/SKILL.md +130 -9
  29. package/skills/whop-people/SKILL.md +50 -6
  30. package/skills/whop-permissions/SKILL.md +8 -5
  31. package/skills/whop-plans/SKILL.md +152 -12
  32. package/skills/whop-products/SKILL.md +141 -13
  33. package/skills/whop-resolution-center-cases/SKILL.md +222 -17
  34. package/skills/whop-setup-intents/SKILL.md +20 -0
  35. package/skills/whop-shipments/SKILL.md +66 -8
  36. package/skills/whop-social-accounts/SKILL.md +112 -11
  37. package/skills/whop-stats/SKILL.md +50 -6
  38. package/skills/whop-swaps/SKILL.md +63 -8
  39. package/skills/whop-team-members/SKILL.md +80 -9
  40. package/skills/whop-transfers/SKILL.md +67 -8
  41. package/skills/whop-users/SKILL.md +295 -18
  42. package/skills/whop-verifications/SKILL.md +51 -9
@@ -9,19 +9,120 @@ A Social Account represents an external profile connected to a Whop account or u
9
9
 
10
10
  Use the Social Accounts API to list connected accounts, create a Whop-managed Facebook page, start an OAuth connection, disconnect a social account, and list a connected profile's posts or a Facebook page's lead forms.
11
11
 
12
- ## Commands
12
+ # whop social-accounts connect
13
13
 
14
- | Command | Description |
15
- |---------|-------------|
16
- | `whop social-accounts list` | List Social Accounts |
17
- | `whop social-accounts create` | Create a Social Account |
18
- | `whop social-accounts connect` | Connect a Social Account |
19
- | `whop social-accounts delete` | Delete a Social Account |
20
- | `whop social-accounts lead_forms` | List Social Account Lead Forms |
21
- | `whop social-accounts posts` | List Social Account Posts |
14
+ Connect a Social Account
22
15
 
23
- Run `whop social-accounts <command> --help` for options, or `whop social-accounts <command> --schema` for full argument details.
16
+ ## Options
17
+
18
+ | Flag | Type | Required | Default | Description |
19
+ |------|------|----------|---------|-------------|
20
+ | `--account_id` | `string` | no | | The Account (biz_ identifier) to connect the social account for. An account-scoped API key may omit this to default to its own account. |
21
+ | `--platform` | `string` | yes | | The platform to connect the social account on. Supported options are `meta_business` and `tiktok`. |
22
+ | `--redirect_url` | `string` | no | | The Whop URL to redirect the user to after they finish connecting. |
23
+ | `--scopes` | `array` | no | | Capabilities to grant for the connected social account. Use `advertise` when connecting a Meta Business or TikTok account for ads. |
24
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
25
+
26
+ > Confirm with the user before executing this destructive command.
27
+
28
+ ---
29
+
30
+ # whop social-accounts create
31
+
32
+ Create a Social Account
33
+
34
+ ## Options
35
+
36
+ | Flag | Type | Required | Default | Description |
37
+ |------|------|----------|---------|-------------|
38
+ | `--account_id` | `string` | no | | The Account (biz_ identifier) to create the social account for. An account-scoped API key may omit this to default to its own account. |
39
+ | `--platform` | `string` | yes | | The platform to create the social account on. |
40
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
41
+
42
+ > Confirm with the user before executing this destructive command.
43
+
44
+ ---
45
+
46
+ # whop social-accounts delete
47
+
48
+ Delete a Social Account
49
+
50
+ ## Arguments
51
+
52
+ | Name | Type | Required | Description |
53
+ |------|------|----------|-------------|
54
+ | `id` | `string` | yes | The ID of the social account to disconnect. |
55
+
56
+ ## Options
57
+
58
+ | Flag | Type | Required | Default | Description |
59
+ |------|------|----------|---------|-------------|
60
+ | `--account_id` | `string` | no | | The Account that the social account is connected to. Provide either this or user_id. |
61
+ | `--user_id` | `string` | no | | The User that the social account is connected to. Provide either this or account_id. |
62
+
63
+ > Confirm with the user before executing this destructive command.
64
+
65
+ ---
66
+
67
+ # whop social-accounts lead_forms
68
+
69
+ List Social Account Lead Forms
70
+
71
+ ## Arguments
72
+
73
+ | Name | Type | Required | Description |
74
+ |------|------|----------|-------------|
75
+ | `id` | `string` | yes | The social account (a sacc_ identifier) whose lead forms to list. |
76
+
77
+ ## Options
78
+
79
+ | Flag | Type | Required | Default | Description |
80
+ |------|------|----------|---------|-------------|
81
+ | `--account_id` | `string` | no | | The Account (a biz_ identifier) the social account is connected to. |
82
+
83
+ ---
84
+
85
+ # whop social-accounts list
86
+
87
+ List Social Accounts
88
+
89
+ ## Options
90
+
91
+ | Flag | Type | Required | Default | Description |
92
+ |------|------|----------|---------|-------------|
93
+ | `--account_id` | `string` | no | | The Account that the social accounts are connected to. Provide either this or user_id. |
94
+ | `--user_id` | `string` | no | | The User that the social accounts are connected to. Provide either this or account_id. |
95
+ | `--platform` | `string` | no | | Only return social accounts for the platform that is specified. |
96
+ | `--verified` | `boolean` | no | | Only return social accounts that are verified on the platform. |
97
+ | `--scopes` | `array` | no | | Only return social accounts that have these scopes. |
98
+ | `--first` | `number` | no | `20` | The number of social accounts to return. |
99
+ | `--after` | `string` | no | | Cursor to fetch the page after (from page_info.end_cursor). |
100
+ | `--last` | `number` | no | | The number of social accounts to return from the end of the range. |
101
+ | `--before` | `string` | no | | Cursor to fetch the page before (from page_info.start_cursor). |
102
+ | `--order` | `string` | no | | The field to sort social accounts by. |
103
+ | `--direction` | `string` | no | | Sort direction. |
104
+
105
+ ---
106
+
107
+ # whop social-accounts posts
108
+
109
+ List Social Account Posts
110
+
111
+ ## Arguments
112
+
113
+ | Name | Type | Required | Description |
114
+ |------|------|----------|-------------|
115
+ | `id` | `string` | yes | The social account (a sacc_ identifier) whose posts to list. |
116
+
117
+ ## Options
118
+
119
+ | Flag | Type | Required | Default | Description |
120
+ |------|------|----------|---------|-------------|
121
+ | `--account_id` | `string` | no | | The Account (a biz_ identifier) the social account is connected to. |
122
+ | `--post_id` | `string` | no | | Return only the single post with this platform id, instead of the full list. |
123
+ | `--first` | `number` | no | `20` | The number of posts to return. |
124
+ | `--after` | `string` | no | | Cursor to fetch the page after (from page_info.end_cursor). |
24
125
 
25
126
  ## Steps that finish in the browser
26
127
 
27
- Some commands respond with a URL the user must open in a browser to finish the flow (`authorize_url`, `session_url`, `deposit_url`) — the CLI cannot complete that step itself. When a response contains one of these fields, or the CLI prints "Action required: open this link in the user's browser", open that link in the user's browser for them, tell them what to complete there, then re-run the matching `get`/`list` command to confirm the step finished.
128
+ Some commands respond with a URL the user must open in a browser to finish the flow (`authorize_url`, `session_url`, `deposit_url`, `checkout_url`) — the CLI cannot complete that step itself. When a response contains one of these fields, or the CLI prints "Action required: open this link in the user's browser", open that link in the user's browser for them, tell them what to complete there, then re-run the matching `get`/`list` command to confirm the step finished.
@@ -9,11 +9,55 @@ Stats represent aggregated activity for an account over time. They help you unde
9
9
 
10
10
  Use the Stats API to list available metrics and their filterable properties, then retrieve time-series values for a date range.
11
11
 
12
- ## Commands
12
+ # whop stats get
13
13
 
14
- | Command | Description |
15
- |---------|-------------|
16
- | `whop stats list` | List Metrics |
17
- | `whop stats get` | Retrieve Metric |
14
+ Retrieve Metric
18
15
 
19
- Run `whop stats <command> --help` for options, or `whop stats <command> --schema` for full argument details.
16
+ ## Arguments
17
+
18
+ | Name | Type | Required | Description |
19
+ |------|------|----------|-------------|
20
+ | `metric` | `string` | yes | The metric to retrieve, for example net_revenue. Use GET /stats to see every metric key. The metric sets the unit and the properties you can filter or break down by. |
21
+
22
+ ## Options
23
+
24
+ | Flag | Type | Required | Default | Description |
25
+ |------|------|----------|---------|-------------|
26
+ | `--account_id` | `string` | no | | The account this query concerns, for example biz_AbC123. |
27
+ | `--from` | `string` | yes | | Start of the range — a date (YYYY-MM-DD), expanded to the start of that day, or an ISO 8601 timestamp (for example 2026-07-16T16:37:00Z), used exactly. |
28
+ | `--to` | `string` | yes | | End of the range — a date (YYYY-MM-DD), expanded to the end of that day, or an ISO 8601 timestamp (for example 2026-07-17T16:37:00Z), used exactly. |
29
+ | `--interval` | `string` | no | | How wide each point is. Defaults to day. Snapshot metrics are day-only. |
30
+ | `--breakdown_by` | `string` | no | | Split the metric out by one of its properties — each point gets a breakdown array. For example breakdown_by=currency returns an entry for usd, an entry for eur, and so on. |
31
+ | `--convert_to` | `string` | no | | Display currency for money metrics — every amount is converted into this ISO currency using the exchange rate on each period's date. Defaults to usd. For the ads metrics (ad_spend, ad_delivery), pass the account's ads reporting currency to match the ad entity endpoints. On transaction metrics, it is ignored when you filter or break down by currency (those report the original transaction currency, unconverted). |
32
+ | `--currency` | `string` | no | | Select the source currency or asset on metrics that list currency. For transaction metrics, for example currency=eur, values are reported without conversion. For market_prices, use btc or xaut and convert_to=usd. Pair with breakdown_by=currency to split a metric by currency. |
33
+ | `--time_zone` | `string` | no | | IANA time zone to bucket the series in, for example America/New_York. Defaults to UTC. Not accepted by snapshot metrics, which are UTC only. |
34
+ | `--payment_method` | `string` | no | | Filter to a single payment method, for example card or crypto. Available on metrics that list payment_method. |
35
+ | `--card_network` | `string` | no | | Filter to a single card brand, for example visa. A refinement of payment_method=card. Available on metrics that list card_network. |
36
+ | `--dispute_reason` | `string` | no | | Filter disputes to a normalized reason, for example product_not_received. Pair with breakdown_by=dispute_reason to split dispute counts by reason. |
37
+ | `--source` | `string` | no | | Filter to a single GMV source, for example payments — or, on the traffic metrics, a visit source (whop_ads, direct, or a utm_source value). Pair with breakdown_by=source to split by source. Available on metrics that list source. |
38
+ | `--hostname` | `string` | no | | Filter traffic metrics to one website hostname, for example shop.example.com. Pair with breakdown_by=hostname to split by website. |
39
+ | `--page` | `string` | no | | Filter traffic metrics to one page — a hostname plus normalized path, for example shop.example.com/pricing. Pair with breakdown_by=page to split by page. |
40
+ | `--device_type` | `string` | no | | Filter traffic metrics to one device type: desktop, mobile, tablet, or unknown. Pair with breakdown_by=device_type to split by device. |
41
+ | `--country_code` | `string` | no | | Filter traffic metrics to one visitor country (uppercase ISO 3166-1 alpha-2, for example US). Pair with breakdown_by=country_code to split by country. |
42
+ | `--event_name` | `string` | no | | Filter the events metric to one tracked event name, for example pixel.page or pixel.custom. Pair with breakdown_by=event_name to split by event. |
43
+ | `--event_type` | `string` | no | | Filter the events metric to a canonical group of events: page_view (pixel page views plus whop.com store views), checkout_start (hosted and embedded checkout views), or other. Pair with breakdown_by=event_type to split by group. |
44
+ | `--custom_name` | `string` | no | | Filter the events metric to one merchant-defined custom event name. Only valid alongside event_name=pixel.custom. Pair with breakdown_by=custom_name to split custom events by name. |
45
+ | `--segment` | `string` | no | | Filter to a single wallet-balance segment, for example available. Pair with breakdown_by=segment to split the balance. Available on metrics that list segment. |
46
+ | `--category` | `string` | no | | Filter to a single balance-activity category, for example payments. Pair with breakdown_by=category to split the activity. Available on metrics that list category. |
47
+ | `--merchant` | `string` | no | | Filter to a single cashback merchant bucket, for example whop-ads. Pair with breakdown_by=merchant to split cashback by merchant. Available on metrics that list merchant. |
48
+ | `--fee_type` | `string` | no | | Filter to a single fee type. Pair with breakdown_by=fee_type to split fees by type. Available on metrics that list fee_type. |
49
+ | `--product` | `string` | no | | Filter to a single product (access pass id), for example prod_AbC123. Pair with breakdown_by=product. Available on metrics that list product. |
50
+ | `--status` | `string` | no | | Filter to a single membership status. Pair with breakdown_by=status. Available on metrics that list status. |
51
+ | `--access_level` | `string` | no | | Filter to a single access level. Pair with breakdown_by=access_level. Available on metrics that list access_level. |
52
+ | `--most_recent_action` | `string` | no | | Filter to a single most-recent member action. Pair with breakdown_by=most_recent_action. Available on metrics that list most_recent_action. |
53
+ | `--referred_user_id` | `string` | no | | Filter a referral metric to the businesses attributed to one person you referred, for example user_AbC123. Available on metrics that list referred_user_id. |
54
+ | `--ad_campaign_ids` | `array` | no | | Ad campaign ids (adcamp_...) to scope the report to; stats are summed across them. Available on metrics that list ad_campaign_ids. |
55
+ | `--ad_group_ids` | `array` | no | | Ad group ids (adgrp_...) to scope the report to; stats are summed across them. Available on metrics that list ad_group_ids. |
56
+ | `--ad_ids` | `array` | no | | Ad ids (ad_...) to scope the report to; stats are summed across them. Available on metrics that list ad_ids. |
57
+ | `--snapshot_window` | `string` | no | | Window used by a snapshot metric. Ordinary snapshots accept 30d as their trailing activity window. Cohorted dispute metrics accept 7d or 28d as the sales-transaction pool; their attribution window is fixed in the metric name. Each metric lists its accepted values in the catalog. |
58
+
59
+ ---
60
+
61
+ # whop stats list
62
+
63
+ List Metrics
@@ -9,13 +9,68 @@ Swaps convert value between supported tokens, chains, or wallet destinations for
9
9
 
10
10
  Use the Swaps API to quote a conversion, create the swap, list recent swaps, and retrieve status until the transaction completes.
11
11
 
12
- ## Commands
12
+ # whop swaps create
13
13
 
14
- | Command | Description |
15
- |---------|-------------|
16
- | `whop swaps status` | List Swaps |
17
- | `whop swaps create` | Create Swap |
18
- | `whop swaps quote` | Create Swap Quote |
19
- | `whop swaps get` | Retrieve Swap |
14
+ Create Swap
20
15
 
21
- Run `whop swaps <command> --help` for options, or `whop swaps <command> --schema` for full argument details.
16
+ ## Options
17
+
18
+ | Flag | Type | Required | Default | Description |
19
+ |------|------|----------|---------|-------------|
20
+ | `--account_id` | `string` | yes | | Business or user account ID (biz_* / user_*). |
21
+ | `--amount` | `unknown` | no | | Source token amount. Required for crypto swaps. Optional for fiat pairs: the portion of the negative to_token balance to repay, which must not exceed the debt; omit to repay the full debt. |
22
+ | `--from_chain` | `number` | no | | Source chain name or chain ID. Defaults to the source token's chain when omitted. |
23
+ | `--from_token` | `string` | yes | | Source token contract address or ticker symbol, such as "USDT". |
24
+ | `--slippage_bps` | `number` | no | | Maximum slippage tolerance in basis points. |
25
+ | `--to_chain` | `number` | no | | Destination chain name or chain ID. Defaults to the destination token's chain when omitted. |
26
+ | `--to_token` | `string` | yes | | Destination token contract address or ticker symbol, such as "XAUT". |
27
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
28
+
29
+ > Confirm with the user before executing this destructive command.
30
+
31
+ ---
32
+
33
+ # whop swaps get
34
+
35
+ Retrieve Swap
36
+
37
+ ## Arguments
38
+
39
+ | Name | Type | Required | Description |
40
+ |------|------|----------|-------------|
41
+ | `id` | `string` | yes | Swap ID returned from POST /swaps. |
42
+
43
+ ---
44
+
45
+ # whop swaps quote
46
+
47
+ Create Swap Quote
48
+
49
+ ## Options
50
+
51
+ | Flag | Type | Required | Default | Description |
52
+ |------|------|----------|---------|-------------|
53
+ | `--amount` | `string` | yes | | Source token amount. |
54
+ | `--from_address` | `unknown` | no | | Source wallet address used for the quote. |
55
+ | `--from_chain` | `number` | no | | Source chain name or chain ID. Defaults to the source token's chain when omitted. |
56
+ | `--from_token` | `string` | yes | | Source token contract address or ticker symbol, such as "USDT". |
57
+ | `--metadata` | `object` | no | | Metadata to include with the quote response. |
58
+ | `--slippage_bps` | `number` | no | | Maximum slippage tolerance in basis points. |
59
+ | `--to_address` | `unknown` | no | | Destination wallet address used for the quote. |
60
+ | `--to_chain` | `number` | no | | Destination chain name or chain ID. Defaults to the destination token's chain when omitted. |
61
+ | `--to_token` | `string` | yes | | Destination token contract address or ticker symbol, such as "XAUT". |
62
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
63
+
64
+ > Confirm with the user before executing this destructive command.
65
+
66
+ ---
67
+
68
+ # whop swaps status
69
+
70
+ List Swaps
71
+
72
+ ## Options
73
+
74
+ | Flag | Type | Required | Default | Description |
75
+ |------|------|----------|---------|-------------|
76
+ | `--account_id` | `string` | no | | Business or user account ID (biz_* / user_*). |
@@ -9,14 +9,85 @@ A Team Member is a member of an account's team: the link between a user and an a
9
9
 
10
10
  Use the Team Members API to list an account's team, add a user to the team with a system role, change a member's role, and remove members. Adding a user who has not yet accepted sends an invitation instead.
11
11
 
12
- ## Commands
12
+ # whop team-members create
13
13
 
14
- | Command | Description |
15
- |---------|-------------|
16
- | `whop team-members list` | List Team Members |
17
- | `whop team-members create` | Create Team Member |
18
- | `whop team-members delete` | Delete Team Member |
19
- | `whop team-members get` | Retrieve Team Member |
20
- | `whop team-members update` | Update Team Member |
14
+ Create Team Member
21
15
 
22
- Run `whop team-members <command> --help` for options, or `whop team-members <command> --schema` for full argument details.
16
+ ## Options
17
+
18
+ | Flag | Type | Required | Default | Description |
19
+ |------|------|----------|---------|-------------|
20
+ | `--account_id` | `string` | yes | | Account ID, prefixed `biz_`. |
21
+ | `--email` | `string` | no | | Email address to invite. Mutually exclusive with `user_id`. If the email already belongs to a Whop account it is treated the same as passing that account's `user_id`; otherwise a pending invite is created for the email. |
22
+ | `--role` | `string` | yes | | The system role to grant. |
23
+ | `--user_id` | `string` | no | | The user to add to the team, prefixed `user_`. Mutually exclusive with `email`. |
24
+ | `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
25
+
26
+ > Confirm with the user before executing this destructive command.
27
+
28
+ ---
29
+
30
+ # whop team-members delete
31
+
32
+ Delete Team Member
33
+
34
+ ## Arguments
35
+
36
+ | Name | Type | Required | Description |
37
+ |------|------|----------|-------------|
38
+ | `id` | `string` | yes | Team member ID — `ausr_` for accepted members, `ausri_` for pending invites. |
39
+
40
+ > Confirm with the user before executing this destructive command.
41
+
42
+ ---
43
+
44
+ # whop team-members get
45
+
46
+ Retrieve Team Member
47
+
48
+ ## Arguments
49
+
50
+ | Name | Type | Required | Description |
51
+ |------|------|----------|-------------|
52
+ | `id` | `string` | yes | Team member ID — `ausr_` for accepted members, `ausri_` for pending invites. |
53
+
54
+ ---
55
+
56
+ # whop team-members list
57
+
58
+ List Team Members
59
+
60
+ ## Options
61
+
62
+ | Flag | Type | Required | Default | Description |
63
+ |------|------|----------|---------|-------------|
64
+ | `--account_id` | `string` | no | | Account ID, prefixed `biz_`. |
65
+ | `--status` | `string` | no | | Only return members with this status: `joined` (accepted members) or `pending` (pending invites). Both are returned by default. |
66
+ | `--user_id` | `string` | no | | Only return the membership for this user ID, prefixed `user_`. |
67
+ | `--role` | `string` | no | | Only return members with this role. `custom` matches members on a dashboard-managed custom role. |
68
+ | `--created_before` | `string` | no | | Only return members added before this ISO 8601 timestamp. |
69
+ | `--created_after` | `string` | no | | Only return members added after this ISO 8601 timestamp. |
70
+ | `--order` | `string` | no | | Field used to sort members. |
71
+ | `--direction` | `string` | no | | Sort direction. Defaults to `desc`. |
72
+ | `--first` | `number` | no | | Number of members to return. Defaults to 20; maximum 100. |
73
+ | `--after` | `string` | no | | Cursor for the next page of members. |
74
+
75
+ ---
76
+
77
+ # whop team-members update
78
+
79
+ Update Team Member
80
+
81
+ ## Arguments
82
+
83
+ | Name | Type | Required | Description |
84
+ |------|------|----------|-------------|
85
+ | `id` | `string` | yes | Team member ID — `ausr_` for accepted members, `ausri_` for pending invites. |
86
+
87
+ ## Options
88
+
89
+ | Flag | Type | Required | Default | Description |
90
+ |------|------|----------|---------|-------------|
91
+ | `--role` | `string` | yes | | The system role to grant. |
92
+
93
+ > Confirm with the user before executing this destructive command.
@@ -9,13 +9,72 @@ Transfers move value between identities on Whop. They are used for account-to-ac
9
9
 
10
10
  Use the Transfers API to create a transfer, list previous transfers, and retrieve a transfer by ID when reconciling money movement between accounts or users.
11
11
 
12
- ## Commands
12
+ # whop transfers create
13
13
 
14
- | Command | Description |
15
- |---------|-------------|
16
- | `whop transfers list` | List Transfers |
17
- | `whop transfers create` | Create Transfer |
18
- | `whop transfers recipients` | List Transfer Recipients |
19
- | `whop transfers get` | Retrieve Transfer |
14
+ Create Transfer
20
15
 
21
- Run `whop transfers <command> --help` for options, or `whop transfers <command> --schema` for full argument details.
16
+ ## Options
17
+
18
+ | Flag | Type | Required | Default | Description |
19
+ |------|------|----------|---------|-------------|
20
+ | `--amount` | `number` | yes | | The amount to move, in the transfer currency. For example 25.00. |
21
+ | `--currency` | `string` | no | | Currency, such as `usd`. Required for ledger transfers. |
22
+ | `--destination_id` | `string` | no | | The recipient. Required for ledger and wallet_send (a user_/biz_/ldgr_ ID, or — for sends — an email). Omit for claim_link. |
23
+ | `--expires_at` | `unknown` | no | | claim_link only. Link expiry as an ISO 8601 timestamp. Defaults to 24 hours from creation. |
24
+ | `--idempotence_key` | `unknown` | no | | Ledger transfers and wallet sends. A unique key that makes retries safe. Retrying with the same key returns the original transfer, or attaches to the original wallet send, instead of moving money twice. |
25
+ | `--metadata` | `unknown` | no | | Ledger transfers only. Custom key-value pairs attached to the transfer. Max 50 keys, 100 chars per key, 500 chars per string value. |
26
+ | `--notes` | `unknown` | no | | Ledger transfers only. A short note describing the transfer. |
27
+ | `--origin_id` | `string` | yes | | The account sending the funds. A user ID (user_xxx), account ID (biz_xxx), or ledger account ID (ldgr_xxx). |
28
+ | `--redeemable_count` | `number` | no | | claim_link only. How many different users can claim the link. Defaults to 1. |
29
+ | `--type` | `string` | no | | The kind of money movement, which decides what comes back. Defaults to ledger. `ledger` moves credit between two Whop balances and returns a `transfer`; `wallet_send` sends USDT from the origin account's Ethereum wallet and returns a `send`; `claim_link` funds a shareable link anyone with the URL can redeem and returns a `claim_link`. A `ledger` transfer from a stablecoin-rails account settles on-chain when covered, and still returns a `transfer`. |
30
+ | `--idempotency-key` | `string` | yes | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
31
+
32
+ > Confirmation policy: For `--type ledger` only, the user's request to execute the transfer counts as confirmation when it includes exact `--origin_id`, `--destination_id`, `--amount`, and `--currency` values and both IDs use a `biz_`, `user_`, or `ldgr_` prefix. Execute that confirmed transfer yourself. This exception does not apply to `wallet_send` or `claim_link`; ask for explicit confirmation before executing those transfer types. Always include a unique `--idempotency-key`. If a result is uncertain, retry the same transfer with the same key.
33
+
34
+ ---
35
+
36
+ # whop transfers get
37
+
38
+ Retrieve Transfer
39
+
40
+ ## Arguments
41
+
42
+ | Name | Type | Required | Description |
43
+ |------|------|----------|-------------|
44
+ | `id` | `string` | yes | The transfer ID. |
45
+
46
+ ---
47
+
48
+ # whop transfers list
49
+
50
+ List Transfers
51
+
52
+ ## Options
53
+
54
+ | Flag | Type | Required | Default | Description |
55
+ |------|------|----------|---------|-------------|
56
+ | `--origin_id` | `string` | no | | Filter to transfers sent from this account. Provide this or destination_id. |
57
+ | `--destination_id` | `string` | no | | Filter to transfers received by this account. Provide this or origin_id. |
58
+ | `--order` | `string` | no | | Sort column. Defaults to created_at. |
59
+ | `--direction` | `string` | no | | Sort direction. Defaults to desc. |
60
+ | `--created_before` | `string` | no | | Only transfers created strictly before this ISO 8601 timestamp. |
61
+ | `--created_after` | `string` | no | | Only transfers created strictly after this ISO 8601 timestamp. |
62
+ | `--first` | `number` | no | `50` | Number of transfers to return from the start of the window. |
63
+ | `--after` | `string` | no | | Cursor to fetch the page after (from page_info.end_cursor). |
64
+ | `--last` | `number` | no | | Number of transfers to return from the end of the window. |
65
+ | `--before` | `string` | no | | Cursor to fetch the page before (from page_info.start_cursor). |
66
+
67
+ ---
68
+
69
+ # whop transfers recipients
70
+
71
+ List Transfer Recipients
72
+
73
+ ## Options
74
+
75
+ | Flag | Type | Required | Default | Description |
76
+ |------|------|----------|---------|-------------|
77
+ | `--origin_id` | `string` | yes | | The originating account ID, prefixed `biz_`. |
78
+ | `--query` | `string` | no | | Search users and accounts by name, username, or ID, in the dashboard's relevance order — this additionally requires the member:basic:read scope. Omit it to get the origin account's team members followed by your own other accounts. Complete email addresses return no matches. |
79
+ | `--first` | `number` | no | `20` | Number of recipients per page. Search queries preserve the dashboard's 20-result maximum. |
80
+ | `--after` | `string` | no | | Cursor to fetch the page after (from page_info.end_cursor). |