@whop/cli 0.14.3 → 0.16.0
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.
- package/README.md +2 -2
- package/dist/index.js +33549 -21195
- package/dist/index.js.map +1 -1
- package/dist/vite.d.ts +1 -1
- package/dist/vite.js +37 -1
- package/dist/vite.js.map +1 -1
- package/package.json +1 -1
- package/skills/whop-accounts/SKILL.md +38 -16
- package/skills/whop-ad-groups/SKILL.md +8 -8
- package/skills/whop-api-keys/SKILL.md +2 -0
- package/skills/whop-apps/SKILL.md +19 -4
- package/skills/whop-audiences/SKILL.md +3 -3
- package/skills/whop-bounties/SKILL.md +28 -0
- package/skills/whop-bounty-submissions/SKILL.md +3 -3
- package/skills/whop-cards/SKILL.md +2 -2
- package/skills/whop-dispute-alerts/SKILL.md +42 -0
- package/skills/whop-disputes/SKILL.md +2 -2
- package/skills/whop-events/SKILL.md +1 -1
- package/skills/whop-exports/SKILL.md +38 -3
- package/skills/whop-ledgers/SKILL.md +1 -0
- package/skills/whop-memberships/SKILL.md +18 -1
- package/skills/whop-notifications/SKILL.md +1 -1
- package/skills/whop-payment-method-domains/SKILL.md +93 -0
- package/skills/whop-payments/SKILL.md +1 -1
- package/skills/whop-payouts/SKILL.md +36 -11
- package/skills/whop-people/SKILL.md +1 -1
- package/skills/whop-plans/SKILL.md +2 -0
- package/skills/whop-products/SKILL.md +1 -0
- package/skills/whop-recommended-actions/SKILL.md +59 -0
- package/skills/whop-setup-intents/SKILL.md +20 -0
- package/skills/whop-social-accounts/SKILL.md +2 -2
- package/skills/whop-stats/SKILL.md +2 -0
- package/skills/whop-swaps/SKILL.md +2 -1
- package/skills/whop-transfers/SKILL.md +2 -2
- package/skills/whop-users/SKILL.md +3 -0
- package/skills/whop-verifications/SKILL.md +2 -2
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-payment-method-domains
|
|
3
|
+
description: Domains verified to show wallet payment methods like Apple Pay at checkout. Run `whop payment-method-domains --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop payment-method-domains
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Payment Method Domain registers a hostname with a wallet provider so its payment methods can appear at a checkout served from that domain. The domain proves ownership by hosting the provider's association file — for Apple Pay, at `/.well-known/apple-developer-merchantid-domain-association` — and `status` reports whether verification has completed.
|
|
9
|
+
|
|
10
|
+
Use the Payment Method Domains API to register domains for your account or its connected accounts, retry verification once the association file is hosted, and remove domains that should no longer serve wallet payments. A domain a platform shares with its connected accounts at checkout is listed on the platform's account, not on each connected account.
|
|
11
|
+
|
|
12
|
+
# whop payment-method-domains create
|
|
13
|
+
|
|
14
|
+
Create Payment Method Domain
|
|
15
|
+
|
|
16
|
+
## Options
|
|
17
|
+
|
|
18
|
+
| Flag | Type | Required | Default | Description |
|
|
19
|
+
|------|------|----------|---------|-------------|
|
|
20
|
+
| `--account_id` | `string` | no | | Account to register the domain for (`biz_` tag). Defaults to the caller's account. |
|
|
21
|
+
| `--hostname` | `string` | yes | | Hostname to register (e.g. `checkout.shinetime.example`). |
|
|
22
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
23
|
+
|
|
24
|
+
> Confirm with the user before executing this destructive command.
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
# whop payment-method-domains delete
|
|
29
|
+
|
|
30
|
+
Delete Payment Method Domain
|
|
31
|
+
|
|
32
|
+
## Arguments
|
|
33
|
+
|
|
34
|
+
| Name | Type | Required | Description |
|
|
35
|
+
|------|------|----------|-------------|
|
|
36
|
+
| `id` | `string` | yes | The unique identifier of the payment method domain, prefixed `pmd_`. |
|
|
37
|
+
|
|
38
|
+
> Confirm with the user before executing this destructive command.
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
# whop payment-method-domains get
|
|
43
|
+
|
|
44
|
+
Retrieve Payment Method Domain
|
|
45
|
+
|
|
46
|
+
## Arguments
|
|
47
|
+
|
|
48
|
+
| Name | Type | Required | Description |
|
|
49
|
+
|------|------|----------|-------------|
|
|
50
|
+
| `id` | `string` | yes | The unique identifier of the payment method domain, prefixed `pmd_`. |
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
# whop payment-method-domains list
|
|
55
|
+
|
|
56
|
+
List Payment Method Domains
|
|
57
|
+
|
|
58
|
+
## Options
|
|
59
|
+
|
|
60
|
+
| Flag | Type | Required | Default | Description |
|
|
61
|
+
|------|------|----------|---------|-------------|
|
|
62
|
+
| `--account_id` | `string` | no | | Only domains registered for this account (`biz_` tag). Defaults to the caller's account plus its connected accounts. |
|
|
63
|
+
| `--hostname` | `string` | no | | Only the domain with this exact hostname. |
|
|
64
|
+
| `--status` | `string` | no | | Only domains with this verification status. |
|
|
65
|
+
| `--provider` | `string` | no | | Only domains registered with this wallet provider. |
|
|
66
|
+
| `--created_before` | `string` | no | | Only domains created before this ISO 8601 timestamp. |
|
|
67
|
+
| `--created_after` | `string` | no | | Only domains created after this ISO 8601 timestamp. |
|
|
68
|
+
| `--order` | `string` | no | | Sort field. |
|
|
69
|
+
| `--direction` | `string` | no | | Sort direction. |
|
|
70
|
+
| `--first` | `number` | no | `20` | Number of domains to return from the start of the window. |
|
|
71
|
+
| `--after` | `string` | no | | Cursor to paginate forwards from. |
|
|
72
|
+
| `--last` | `number` | no | | Number of domains to return from the end of the window. |
|
|
73
|
+
| `--before` | `string` | no | | Cursor to paginate backwards from. |
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
# whop payment-method-domains verify
|
|
78
|
+
|
|
79
|
+
Verify Payment Method Domain
|
|
80
|
+
|
|
81
|
+
## Arguments
|
|
82
|
+
|
|
83
|
+
| Name | Type | Required | Description |
|
|
84
|
+
|------|------|----------|-------------|
|
|
85
|
+
| `id` | `string` | yes | The unique identifier of the payment method domain, prefixed `pmd_`. |
|
|
86
|
+
|
|
87
|
+
## Options
|
|
88
|
+
|
|
89
|
+
| Flag | Type | Required | Default | Description |
|
|
90
|
+
|------|------|----------|---------|-------------|
|
|
91
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
92
|
+
|
|
93
|
+
> Confirm with the user before executing this destructive command.
|
|
@@ -23,7 +23,7 @@ Update payment return URL
|
|
|
23
23
|
|
|
24
24
|
| Flag | Type | Required | Default | Description |
|
|
25
25
|
|------|------|----------|---------|-------------|
|
|
26
|
-
| `--return_url` | `string` | yes | | Where the buyer continues after completing an off-site step. Must be an absolute https URL without credentials, at most 2,048 characters. |
|
|
26
|
+
| `--return_url` | `string` | yes | | Where the buyer continues after completing an off-site step. Must be an absolute https URL without credentials (http is allowed for localhost), at most 2,048 characters. |
|
|
27
27
|
|
|
28
28
|
> Confirm with the user before executing this destructive command.
|
|
29
29
|
|
|
@@ -7,7 +7,7 @@ command: whop payouts
|
|
|
7
7
|
|
|
8
8
|
Payouts represent money sent from an account or user balance to an external destination, such as a bank account, wallet, or other saved payout method.
|
|
9
9
|
|
|
10
|
-
Use the Payouts API to create
|
|
10
|
+
Use the Payouts API to create and track payouts, manage saved payout methods, and show expected arrival details for funds leaving Whop.
|
|
11
11
|
|
|
12
12
|
# whop payouts create
|
|
13
13
|
|
|
@@ -17,10 +17,16 @@ Create Payout
|
|
|
17
17
|
|
|
18
18
|
| Flag | Type | Required | Default | Description |
|
|
19
19
|
|------|------|----------|---------|-------------|
|
|
20
|
-
| `--account_id` | `string` |
|
|
20
|
+
| `--account_id` | `string` | no | | Account to pay out from, prefixed `biz_`. Provide exactly one of `account_id` or `user_id`. |
|
|
21
|
+
| `--acknowledge_bank_warning` | `boolean` | no | | Set to `true` to continue when the destination bank could not confirm the payout method account holder's name, or `false` to have the payout refused in that case so the account holder can correct the name or link their bank first. Omitting the field skips the warning gate — a client that cannot show the warning keeps its pre-gate behavior. |
|
|
21
22
|
| `--amount` | `number` | yes | | The amount to pay out in the specified currency. |
|
|
22
|
-
| `--currency` | `string` | no | | The payout currency. Defaults to usd
|
|
23
|
+
| `--currency` | `string` | no | | The currency to pay out. Balances are held per currency and the payout draws only from the balance in this currency, so match the currency the funds arrived in — for example `cad` for an account funded by CAD transfers. Defaults to `usd`. |
|
|
24
|
+
| `--idempotency_key` | `unknown` | no | | A unique key that makes retries safe. Retrying with the same key returns the original payout instead of paying out twice. Also accepted as the `Idempotency-Key` header. |
|
|
25
|
+
| `--notes` | `unknown` | no | | Free-form notes to attach to the payout, with a maximum of 255 characters. Omit or pass `null` for no notes. |
|
|
23
26
|
| `--payout_method_id` | `string` | yes | | The saved payout method to deliver to (a potk_ identifier). |
|
|
27
|
+
| `--platform_covers_fees` | `boolean` | no | | Whether the parent platform covers the payout fee instead of the account being paid out. Omit to use the platform's configured fee coverage policy; pass `false` to opt out of it. `true` is only accepted for accounts that belong to a platform, and requires the platform's policy to cover this payout method's category or a caller authorized to manage the platform's child account fees. |
|
|
28
|
+
| `--speed` | `string` | no | | How fast the funds should arrive. `instant` is only accepted when the account and payout method are eligible; otherwise the payout is rejected. |
|
|
29
|
+
| `--user_id` | `string` | no | | User to pay out from, prefixed `user_`. Provide exactly one of `account_id` or `user_id`. |
|
|
24
30
|
| `--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
31
|
|
|
26
32
|
> Confirm with the user before executing this destructive command.
|
|
@@ -35,13 +41,13 @@ Create Saved Payout Method
|
|
|
35
41
|
|
|
36
42
|
| Flag | Type | Required | Default | Description |
|
|
37
43
|
|------|------|----------|---------|-------------|
|
|
38
|
-
| `--account_id` | `string` | no | | The account to add the payout method for
|
|
44
|
+
| `--account_id` | `string` | no | | The account to add the payout method for, prefixed `biz_`. Provide this or `user_id`. |
|
|
39
45
|
| `--destination_currency` | `string` | no | `usd` | Currency the supported payout method delivers payouts in. |
|
|
40
|
-
| `--fields` | `object` |
|
|
46
|
+
| `--fields` | `object` | no | | The supported payout method's required field values, keyed by field id — list them with `GET /payouts/supported_methods?supported_payout_method_id=...`. A Basis Theory token id may be passed in place of a raw value. For a U.S. bank routing-number field, a raw nine-digit value must also pass the ABA checksum. A validation failure returns the method's full required_fields schema alongside the error. Required whenever the account details are supplied directly. |
|
|
41
47
|
| `--is_default` | `boolean` | no | `false` | Whether to make this the account's default payout method. |
|
|
42
|
-
| `--nickname` | `string` |
|
|
48
|
+
| `--nickname` | `string` | no | | A label for the payout method, unique per destination. |
|
|
43
49
|
| `--supported_payout_method_id` | `string` | yes | | The supported payout method to save (a podst_ identifier from a previous listing). |
|
|
44
|
-
| `--user_id` | `string` | no | | The user to add the payout method for
|
|
50
|
+
| `--user_id` | `string` | no | | The user to add the payout method for, prefixed `user_`. Provide this or `account_id`. |
|
|
45
51
|
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
46
52
|
|
|
47
53
|
> Confirm with the user before executing this destructive command.
|
|
@@ -56,12 +62,31 @@ Delete Saved Payout Method
|
|
|
56
62
|
|
|
57
63
|
| Name | Type | Required | Description |
|
|
58
64
|
|------|------|----------|-------------|
|
|
59
|
-
| `
|
|
65
|
+
| `id` | `string` | yes | Payout method ID, prefixed `potk_`. |
|
|
60
66
|
|
|
61
67
|
> Confirm with the user before executing this destructive command.
|
|
62
68
|
|
|
63
69
|
---
|
|
64
70
|
|
|
71
|
+
# whop payouts get
|
|
72
|
+
|
|
73
|
+
Retrieve Payout
|
|
74
|
+
|
|
75
|
+
## Arguments
|
|
76
|
+
|
|
77
|
+
| Name | Type | Required | Description |
|
|
78
|
+
|------|------|----------|-------------|
|
|
79
|
+
| `id` | `string` | yes | Payout ID, prefixed `wdrl_` for a payout returned by `GET /payouts` or `cofr_` for the payout request returned by `POST /payouts`. |
|
|
80
|
+
|
|
81
|
+
## Options
|
|
82
|
+
|
|
83
|
+
| Flag | Type | Required | Default | Description |
|
|
84
|
+
|------|------|----------|---------|-------------|
|
|
85
|
+
| `--account_id` | `string` | no | | Owning account ID, prefixed `biz_`. Provide exactly one of `account_id` or `user_id`. |
|
|
86
|
+
| `--user_id` | `string` | no | | Owning user ID, prefixed `user_`. Provide exactly one of `account_id` or `user_id`. |
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
65
90
|
# whop payouts list
|
|
66
91
|
|
|
67
92
|
List Payouts
|
|
@@ -111,7 +136,7 @@ List Supported Payout Methods
|
|
|
111
136
|
|------|------|----------|---------|-------------|
|
|
112
137
|
| `--account_id` | `string` | no | | The owning account ID (a biz_ identifier). Provide this or user_id. |
|
|
113
138
|
| `--user_id` | `string` | no | | The owning user ID (a user_ identifier). Provide this or account_id. |
|
|
114
|
-
| `--country` | `string` | no | | ISO 3166-1 alpha-2 country code for the bank account or wallet, such as `US`. Defaults to the payout account's country. |
|
|
139
|
+
| `--country` | `string` | no | | ISO 3166-1 alpha-2 country code for the bank account or wallet, such as `US`. Defaults to the country of supported_payout_method_id when one is given, otherwise the payout account's country. |
|
|
115
140
|
| `--amount` | `number` | no | | Optional withdrawal amount in whole currency units, for example `250.00`. When provided, each destination includes per-currency fee and delivery quotes. |
|
|
116
141
|
| `--currency` | `string` | no | `usd` | Currency code of the amount, for example `usd`. Only meaningful with amount. |
|
|
117
142
|
| `--supported_payout_method_id` | `string` | no | | Narrows the list to one supported payout method (a podst_ identifier) and includes the required_fields needed to save it as a payout method. |
|
|
@@ -131,12 +156,12 @@ Rename Saved Payout Method
|
|
|
131
156
|
|
|
132
157
|
| Name | Type | Required | Description |
|
|
133
158
|
|------|------|----------|-------------|
|
|
134
|
-
| `
|
|
159
|
+
| `id` | `string` | yes | Payout method ID, prefixed `potk_`. |
|
|
135
160
|
|
|
136
161
|
## Options
|
|
137
162
|
|
|
138
163
|
| Flag | Type | Required | Default | Description |
|
|
139
164
|
|------|------|----------|---------|-------------|
|
|
140
|
-
| `--nickname` | `string` | yes | | New label for the payout method. |
|
|
165
|
+
| `--nickname` | `string` | yes | | New label for the payout method, with at least one non-whitespace character and a maximum of 100 characters. |
|
|
141
166
|
|
|
142
167
|
> Confirm with the user before executing this destructive command.
|
|
@@ -17,7 +17,7 @@ Retrieve Person
|
|
|
17
17
|
|
|
18
18
|
| Name | Type | Required | Description |
|
|
19
19
|
|------|------|----------|-------------|
|
|
20
|
-
| `
|
|
20
|
+
| `id` | `string` | yes | The person ID, user ID, email address, or phone number to look up. |
|
|
21
21
|
|
|
22
22
|
## Options
|
|
23
23
|
|
|
@@ -137,6 +137,8 @@ Update Plan
|
|
|
137
137
|
|------|------|----------|---------|-------------|
|
|
138
138
|
| `--adaptive_pricing_enabled` | `boolean` | no | | Whether this plan accepts local currency payments via adaptive pricing. |
|
|
139
139
|
| `--billing_period` | `number` | no | | Recurring billing interval in days, such as 30 for monthly or 365 for annual. |
|
|
140
|
+
| `--cancel_discount_intervals` | `number` | no | | How many renewals the retention discount applies to. Required when `offer_cancel_discount` is true. |
|
|
141
|
+
| `--cancel_discount_percentage` | `number` | no | | Percentage taken off each discounted renewal. Required when `offer_cancel_discount` is true. |
|
|
140
142
|
| `--checkout_styling` | `unknown` | no | | Checkout styling overrides for this plan. |
|
|
141
143
|
| `--currency` | `string` | no | | The three-letter ISO currency code for the plan's pricing. Defaults to USD. |
|
|
142
144
|
| `--custom_fields` | `unknown` | no | | An array of custom field definitions to collect from customers at checkout. Omitting this field clears existing custom fields. |
|
|
@@ -141,6 +141,7 @@ Update Product
|
|
|
141
141
|
|
|
142
142
|
| Flag | Type | Required | Default | Description |
|
|
143
143
|
|------|------|----------|---------|-------------|
|
|
144
|
+
| `--banner_image` | `unknown` | no | | A wide image for the product, shown on the product page and on listing cards. Pass `{ id }` for an existing attachment or `{ direct_upload_id }` for a completed direct upload; `null` removes it. |
|
|
144
145
|
| `--description` | `unknown` | no | | A written description displayed on the product page. |
|
|
145
146
|
| `--headline` | `unknown` | no | | A short marketing headline for the product page. |
|
|
146
147
|
| `--metadata` | `unknown` | no | | Custom key-value pairs to store on the product. |
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: whop-recommended-actions
|
|
3
|
+
description: Suggested next-step action chains for an account. Run `whop recommended-actions --help` for usage details.
|
|
4
|
+
requires_bin: whop
|
|
5
|
+
command: whop recommended-actions
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
A Recommended Action Chain is a short, ordered sequence of dashboard actions — create a product, price it, publish it — suggested for an account based on what it already has. Seeded chains come from hand-written presets; generated chains, produced per account, share the same shape.
|
|
9
|
+
|
|
10
|
+
Use the Recommended Actions API to list the chains recommended for an account and to record that a chain was run. Running a chain executes nothing server-side — the client follows each step's CTA itself; the run endpoint records the `recommended_action_chain.executed` analytics event.
|
|
11
|
+
|
|
12
|
+
# whop recommended-actions create
|
|
13
|
+
|
|
14
|
+
Run Recommended Action
|
|
15
|
+
|
|
16
|
+
## Arguments
|
|
17
|
+
|
|
18
|
+
| Name | Type | Required | Description |
|
|
19
|
+
|------|------|----------|-------------|
|
|
20
|
+
| `id` | `string` | yes | Chain ID from the list endpoint, e.g. `rac_seed_start_selling_9f2c1a7b04`. |
|
|
21
|
+
|
|
22
|
+
## Options
|
|
23
|
+
|
|
24
|
+
| Flag | Type | Required | Default | Description |
|
|
25
|
+
|------|------|----------|---------|-------------|
|
|
26
|
+
| `--account_id` | `string` | no | | Account ID, prefixed `biz_`. Defaults to the API key's own account. |
|
|
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 recommended-actions get
|
|
34
|
+
|
|
35
|
+
Retrieve Recommended Action
|
|
36
|
+
|
|
37
|
+
## Arguments
|
|
38
|
+
|
|
39
|
+
| Name | Type | Required | Description |
|
|
40
|
+
|------|------|----------|-------------|
|
|
41
|
+
| `id` | `string` | yes | Chain ID from the list endpoint, e.g. `rac_seed_start_selling_9f2c1a7b04`. |
|
|
42
|
+
|
|
43
|
+
## Options
|
|
44
|
+
|
|
45
|
+
| Flag | Type | Required | Default | Description |
|
|
46
|
+
|------|------|----------|---------|-------------|
|
|
47
|
+
| `--account_id` | `string` | no | | Account ID, prefixed `biz_`. Defaults to the API key's own account. |
|
|
48
|
+
|
|
49
|
+
---
|
|
50
|
+
|
|
51
|
+
# whop recommended-actions list
|
|
52
|
+
|
|
53
|
+
List Recommended Actions
|
|
54
|
+
|
|
55
|
+
## Options
|
|
56
|
+
|
|
57
|
+
| Flag | Type | Required | Default | Description |
|
|
58
|
+
|------|------|----------|---------|-------------|
|
|
59
|
+
| `--account_id` | `string` | no | | Account ID, prefixed `biz_`. Defaults to the API key's own account. |
|
|
@@ -9,6 +9,26 @@ A Setup Intent saves a buyer's payment method for later without taking money now
|
|
|
9
9
|
|
|
10
10
|
Poll [Retrieve status](https://docs.whop.com/api-reference/beta/setup-intents/retrieve-status) for how far the setup has got and what is outstanding. Once it reaches `succeeded` the method is on file and can be charged.
|
|
11
11
|
|
|
12
|
+
# whop setup-intents return_url
|
|
13
|
+
|
|
14
|
+
Update setup return URL
|
|
15
|
+
|
|
16
|
+
## Arguments
|
|
17
|
+
|
|
18
|
+
| Name | Type | Required | Description |
|
|
19
|
+
|------|------|----------|-------------|
|
|
20
|
+
| `setup_intent_id` | `string` | yes | The unique identifier of the setup intent. |
|
|
21
|
+
|
|
22
|
+
## Options
|
|
23
|
+
|
|
24
|
+
| Flag | Type | Required | Default | Description |
|
|
25
|
+
|------|------|----------|---------|-------------|
|
|
26
|
+
| `--return_url` | `string` | yes | | Where the buyer continues after completing an off-site step. Must be an absolute https URL without credentials (http is allowed for localhost), at most 2,048 characters. |
|
|
27
|
+
|
|
28
|
+
> Confirm with the user before executing this destructive command.
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
12
32
|
# whop setup-intents status
|
|
13
33
|
|
|
14
34
|
Retrieve setup status
|
|
@@ -35,8 +35,8 @@ Create a Social Account
|
|
|
35
35
|
|
|
36
36
|
| Flag | Type | Required | Default | Description |
|
|
37
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. |
|
|
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. Account API keys cannot update their own account's branding through Update Account; use a user-authenticated path. |
|
|
39
|
+
| `--platform` | `string` | yes | | The platform to create the social account on. `facebook` requires the account's `banner_image`, `logo`, and `description`; configure them with [Update Account](/api-reference/beta/accounts/update-account). |
|
|
40
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
41
|
|
|
42
42
|
> Confirm with the user before executing this destructive command.
|
|
@@ -24,6 +24,7 @@ Retrieve Metric
|
|
|
24
24
|
| Flag | Type | Required | Default | Description |
|
|
25
25
|
|------|------|----------|---------|-------------|
|
|
26
26
|
| `--account_id` | `string` | no | | The account this query concerns, for example biz_AbC123. |
|
|
27
|
+
| `--user_id` | `string` | no | | The user this query concerns, for example user_AbC123. Available on metrics that support user subjects, such as account_balance. |
|
|
27
28
|
| `--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
29
|
| `--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
30
|
| `--interval` | `string` | no | | How wide each point is. Defaults to day. Snapshot metrics are day-only. |
|
|
@@ -55,6 +56,7 @@ Retrieve Metric
|
|
|
55
56
|
| `--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
57
|
| `--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
58
|
| `--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. |
|
|
59
|
+
| `--event` | `string` | no | | Filter the events metric to one or more full event names, for example payment.completed or pixel.lead. Comma-separate several to break the metric down by each event. Available on metrics that list event. |
|
|
58
60
|
|
|
59
61
|
---
|
|
60
62
|
|
|
@@ -18,10 +18,11 @@ Create Swap
|
|
|
18
18
|
| Flag | Type | Required | Default | Description |
|
|
19
19
|
|------|------|----------|---------|-------------|
|
|
20
20
|
| `--account_id` | `string` | yes | | Business or user account ID (biz_* / user_*). |
|
|
21
|
-
| `--amount` | `unknown` | no | | Source token amount. Required for crypto swaps.
|
|
21
|
+
| `--amount` | `unknown` | no | | Source token amount. Required for crypto swaps. For fiat pairs: the amount of from_token to convert at the mid-market rate; omit (along with to_amount) to repay the full negative to_token balance instead. |
|
|
22
22
|
| `--from_chain` | `number` | no | | Source chain name or chain ID. Defaults to the source token's chain when omitted. |
|
|
23
23
|
| `--from_token` | `string` | yes | | Source token contract address or ticker symbol, such as "USDT". |
|
|
24
24
|
| `--slippage_bps` | `number` | no | | Maximum slippage tolerance in basis points. |
|
|
25
|
+
| `--to_amount` | `unknown` | no | | Fiat pairs only: sizes a partial repayment of the negative to_token balance, denominated in to_token. Must not exceed the debt. Mutually exclusive with amount. |
|
|
25
26
|
| `--to_chain` | `number` | no | | Destination chain name or chain ID. Defaults to the destination token's chain when omitted. |
|
|
26
27
|
| `--to_token` | `string` | yes | | Destination token contract address or ticker symbol, such as "XAUT". |
|
|
27
28
|
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
@@ -74,7 +74,7 @@ List Transfer Recipients
|
|
|
74
74
|
|
|
75
75
|
| Flag | Type | Required | Default | Description |
|
|
76
76
|
|------|------|----------|---------|-------------|
|
|
77
|
-
| `--origin_id` | `string` | yes | | The
|
|
78
|
-
| `--query` | `string` | no | | Search
|
|
77
|
+
| `--origin_id` | `string` | yes | | The account sending the money: a company account ID (`biz_`), or a user ID (`user_`) for that user's own personal balance. |
|
|
78
|
+
| `--query` | `string` | no | | Search anyone on Whop by name or username, plus your own accounts by name or ID. Omit it to get the team around the balance, the people you follow, and your own accounts. The list is the same whether the balance belongs to a company or to you. Searching from a `biz_` origin additionally requires the member:basic:read scope. A credential scoped to a single company is the exception to the search itself: it only ever sees that company's own people. Complete email addresses return no matches. |
|
|
79
79
|
| `--first` | `number` | no | `20` | Number of recipients per page. Search queries preserve the dashboard's 20-result maximum. |
|
|
80
80
|
| `--after` | `string` | no | | Cursor to fetch the page after (from page_info.end_cursor). |
|
|
@@ -266,6 +266,7 @@ Update User
|
|
|
266
266
|
| Flag | Type | Required | Default | Description |
|
|
267
267
|
|------|------|----------|---------|-------------|
|
|
268
268
|
| `--account_id` | `string` | no | | The account whose profile override to update. Required for API key callers. |
|
|
269
|
+
| `--banner` | `unknown` | no | | |
|
|
269
270
|
| `--bio` | `string` | no | | |
|
|
270
271
|
| `--name` | `string` | no | | |
|
|
271
272
|
| `--profile_picture` | `object` | no | | |
|
|
@@ -284,6 +285,7 @@ Update Current User
|
|
|
284
285
|
| Flag | Type | Required | Default | Description |
|
|
285
286
|
|------|------|----------|---------|-------------|
|
|
286
287
|
| `--account_id` | `string` | no | | When set, updates the authenticated user's profile override for this account instead of their global profile. |
|
|
288
|
+
| `--banner` | `unknown` | no | | |
|
|
287
289
|
| `--bio` | `string` | no | | |
|
|
288
290
|
| `--name` | `string` | no | | |
|
|
289
291
|
| `--profile_picture` | `object` | no | | |
|
|
@@ -301,6 +303,7 @@ Update
|
|
|
301
303
|
|
|
302
304
|
| Flag | Type | Required | Default | Description |
|
|
303
305
|
|------|------|----------|---------|-------------|
|
|
306
|
+
| `--bounty_worker_onboarding_dismissed` | `boolean` | no | | Whether the user has dismissed the first-time bounty worker onboarding. Set to `false` to show it again. |
|
|
304
307
|
| `--investigation_enabled` | `boolean` | no | | Whether investigation mode is enabled for the user. Only meaningful for staff users with investigation access. |
|
|
305
308
|
|
|
306
309
|
> Confirm with the user before executing this destructive command.
|
|
@@ -32,7 +32,7 @@ Retrieve Verification
|
|
|
32
32
|
|
|
33
33
|
| Name | Type | Required | Description |
|
|
34
34
|
|------|------|----------|-------------|
|
|
35
|
-
| `
|
|
35
|
+
| `id` | `string` | yes | Verification profile ID, prefixed `idpf_`. |
|
|
36
36
|
|
|
37
37
|
---
|
|
38
38
|
|
|
@@ -58,7 +58,7 @@ Update Verification
|
|
|
58
58
|
|
|
59
59
|
| Name | Type | Required | Description |
|
|
60
60
|
|------|------|----------|-------------|
|
|
61
|
-
| `
|
|
61
|
+
| `id` | `string` | yes | Verification profile ID, prefixed `idpf_`. |
|
|
62
62
|
|
|
63
63
|
> Confirm with the user before executing this destructive command.
|
|
64
64
|
|