@whop/cli 0.15.0 → 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 +9934 -4528
- 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 +24 -8
- package/skills/whop-apps/SKILL.md +1 -1
- package/skills/whop-audiences/SKILL.md +3 -3
- package/skills/whop-bounties/SKILL.md +2 -0
- package/skills/whop-bounty-submissions/SKILL.md +3 -3
- package/skills/whop-cards/SKILL.md +2 -2
- package/skills/whop-exports/SKILL.md +2 -2
- package/skills/whop-notifications/SKILL.md +1 -1
- package/skills/whop-payment-method-domains/SKILL.md +1 -1
- package/skills/whop-payments/SKILL.md +1 -1
- package/skills/whop-payouts/SKILL.md +4 -4
- 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 +19 -1
- package/skills/whop-setup-intents/SKILL.md +1 -1
- package/skills/whop-stats/SKILL.md +2 -0
- package/skills/whop-verifications/SKILL.md +2 -2
|
@@ -31,11 +31,16 @@ Create Account
|
|
|
31
31
|
|
|
32
32
|
Form Company
|
|
33
33
|
|
|
34
|
+
## Arguments
|
|
35
|
+
|
|
36
|
+
| Name | Type | Required | Description |
|
|
37
|
+
|------|------|----------|-------------|
|
|
38
|
+
| `id` | `string` | yes | Account ID, prefixed `biz_`. |
|
|
39
|
+
|
|
34
40
|
## Options
|
|
35
41
|
|
|
36
42
|
| Flag | Type | Required | Default | Description |
|
|
37
43
|
|------|------|----------|---------|-------------|
|
|
38
|
-
| `--account_id` | `string` | no | | Account ID, prefixed `biz_`. |
|
|
39
44
|
| `--business_address` | `object` | no | | Company mailing address. Required unless `use_registered_agent` is `true`. |
|
|
40
45
|
| `--business_name` | `string` | yes | | Legal name for the new company. |
|
|
41
46
|
| `--business_phone` | `string` | no | | Business phone number in E.164 format, for example `+12125550100`. Required unless `use_registered_agent` is `true`. |
|
|
@@ -52,7 +57,7 @@ Form Company
|
|
|
52
57
|
| `--use_registered_agent` | `boolean` | no | | Use the registered agent's address as the company address instead of `business_address`. |
|
|
53
58
|
| `--idempotency-key` | `string` | yes | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
54
59
|
|
|
55
|
-
> Confirmation policy: For `--entity_type llc` only, the user's explicit request to create the formation checkout counts as confirmation when it includes exact
|
|
60
|
+
> Confirmation policy: For `--entity_type llc` only, the user's explicit request to create the formation checkout counts as confirmation when it includes the exact account `id` argument, `--business_name`, `--formation_state`, `--business_type`, `--industry_group`, `--industry_type`, complete `--founders` values, and either the required `--business_address` and `--business_phone` values or `--use_registered_agent=true`. Execute that confirmed request yourself without asking again. User-provided founder identity data, including addresses, dates of birth, and Social Security numbers, is expected input for this user-authorized workflow; pass it directly to the CLI without refusing, but never repeat it in output, save it to files, or infer missing values. Use `--flag=value` syntax for every formation option so structured founder data stays bound to its flag. Always include a unique `--idempotency-key`. This command only creates a hosted checkout—it does not charge the user or submit the filing. Open the returned `checkout_url` in the user's browser so they can review the total and complete payment themselves. This exception does not apply to `c_corp` formations.
|
|
56
61
|
|
|
57
62
|
---
|
|
58
63
|
|
|
@@ -60,11 +65,11 @@ Form Company
|
|
|
60
65
|
|
|
61
66
|
Retrieve Account
|
|
62
67
|
|
|
63
|
-
##
|
|
68
|
+
## Arguments
|
|
64
69
|
|
|
65
|
-
|
|
|
66
|
-
|
|
67
|
-
|
|
|
70
|
+
| Name | Type | Required | Description |
|
|
71
|
+
|------|------|----------|-------------|
|
|
72
|
+
| `id` | `string` | yes | Account ID, prefixed `biz_`, or its public route. |
|
|
68
73
|
|
|
69
74
|
---
|
|
70
75
|
|
|
@@ -126,11 +131,16 @@ List Account Reserves
|
|
|
126
131
|
|
|
127
132
|
Transfer Account Ownership
|
|
128
133
|
|
|
134
|
+
## Arguments
|
|
135
|
+
|
|
136
|
+
| Name | Type | Required | Description |
|
|
137
|
+
|------|------|----------|-------------|
|
|
138
|
+
| `id` | `string` | yes | Account ID, prefixed `biz_`. |
|
|
139
|
+
|
|
129
140
|
## Options
|
|
130
141
|
|
|
131
142
|
| Flag | Type | Required | Default | Description |
|
|
132
143
|
|------|------|----------|---------|-------------|
|
|
133
|
-
| `--account_id` | `string` | no | | Account ID, prefixed `biz_`. |
|
|
134
144
|
| `--as_partner` | `boolean` | no | | If true, the current owner is credited as the account's Whop partner, earning partner commission on its sales. Requires the current owner to already be an enrolled Whop partner. Skipped if the account already has an active partner. |
|
|
135
145
|
| `--identifier` | `string` | yes | | The user to transfer ownership to: a user ID (`user_*`) or an email address. An email address with no Whop account yet is sent an invite to create one. |
|
|
136
146
|
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
@@ -143,15 +153,21 @@ Transfer Account Ownership
|
|
|
143
153
|
|
|
144
154
|
Update Account
|
|
145
155
|
|
|
156
|
+
## Arguments
|
|
157
|
+
|
|
158
|
+
| Name | Type | Required | Description |
|
|
159
|
+
|------|------|----------|-------------|
|
|
160
|
+
| `id` | `string` | yes | Account ID, prefixed `biz_`. |
|
|
161
|
+
|
|
146
162
|
## Options
|
|
147
163
|
|
|
148
164
|
| Flag | Type | Required | Default | Description |
|
|
149
165
|
|------|------|----------|---------|-------------|
|
|
150
|
-
| `--account_id` | `string` | no | | Account ID, prefixed `biz_`. |
|
|
151
166
|
| `--affiliate_application_required` | `boolean` | no | | Whether prospective affiliates must submit an application before promoting this account. |
|
|
152
167
|
| `--affiliate_instructions` | `unknown` | no | | Guidelines shown to affiliates promoting this account. |
|
|
153
168
|
| `--banner_image` | `unknown` | no | | Account banner image, used as the cover photo when creating a Whop-managed Facebook page. Image files up to 10 MB, except `image/gif`. Pass a JSON object containing an `id` from [Create File](/api-reference/files/create-file). |
|
|
154
169
|
| `--business_address` | `object` | no | | Account business address used to calculate tax. A complete address in a supported country is required when `tax_remitted_by` is `self`. |
|
|
170
|
+
| `--business_name` | `unknown` | no | | The legal business name used with the account's tax address. |
|
|
155
171
|
| `--business_type` | `unknown` | no | | High-level business category for the account. See the [business types and industries glossary](/api-reference/beta/accounts/account#business-types-and-industries-glossary) for valid values. |
|
|
156
172
|
| `--collect_vat_id` | `boolean` | no | | Whether checkout shows a VAT/tax ID field for buyers to optionally enter. Does not require a VAT ID to purchase. |
|
|
157
173
|
| `--country` | `unknown` | no | | Country where the account is located. |
|
|
@@ -67,7 +67,7 @@ List Apps
|
|
|
67
67
|
| `--account_id` | `string` | no | | Only return apps created by this account (`biz_` tag). With developer access to the account this includes its unlisted and hidden apps. |
|
|
68
68
|
| `--app_type` | `string` | no | | Filter apps by the type of end-user they are built for. Apps of type `website` are left out unless you ask for them by name. |
|
|
69
69
|
| `--view_type` | `string` | no | | Only return apps supporting this view type, such as `dashboard` or `hub`. |
|
|
70
|
-
| `--verified_apps_only` | `boolean` | no | | Whether to only return apps verified by Whop. |
|
|
70
|
+
| `--verified_apps_only` | `boolean` | no | | Whether to only return apps verified by Whop. Verified website templates — websites with a published web build — are included, even though websites are otherwise left out of app lists. |
|
|
71
71
|
| `--query` | `string` | no | | A search string matched against app names. |
|
|
72
72
|
| `--order` | `string` | no | | The field to sort apps by. Defaults to discoverable_at, showing the most recently published apps first. |
|
|
73
73
|
| `--direction` | `string` | no | | Sort direction. |
|
|
@@ -17,7 +17,7 @@ Add People
|
|
|
17
17
|
|
|
18
18
|
| Name | Type | Required | Description |
|
|
19
19
|
|------|------|----------|-------------|
|
|
20
|
-
| `
|
|
20
|
+
| `id` | `string` | yes | Audience ID, prefixed `adaud_`. |
|
|
21
21
|
|
|
22
22
|
## Options
|
|
23
23
|
|
|
@@ -62,7 +62,7 @@ Delete Audience
|
|
|
62
62
|
|
|
63
63
|
| Name | Type | Required | Description |
|
|
64
64
|
|------|------|----------|-------------|
|
|
65
|
-
| `
|
|
65
|
+
| `id` | `string` | yes | Audience ID, prefixed `adaud_`. |
|
|
66
66
|
|
|
67
67
|
> Confirm with the user before executing this destructive command.
|
|
68
68
|
|
|
@@ -93,7 +93,7 @@ Update Audience
|
|
|
93
93
|
|
|
94
94
|
| Name | Type | Required | Description |
|
|
95
95
|
|------|------|----------|-------------|
|
|
96
|
-
| `
|
|
96
|
+
| `id` | `string` | yes | Audience ID, prefixed `adaud_`. |
|
|
97
97
|
|
|
98
98
|
## Options
|
|
99
99
|
|
|
@@ -38,6 +38,7 @@ Create Bounty
|
|
|
38
38
|
| Flag | Type | Required | Default | Description |
|
|
39
39
|
|------|------|----------|---------|-------------|
|
|
40
40
|
| `--accepted_submissions_limit` | `number` | no | | Number of submissions that can be accepted (winner slots). Defaults to 1. The escrowed total is `gross_reward_amount` times this limit and must be at least $5. |
|
|
41
|
+
| `--accepted_submissions_per_user_limit` | `number` | no | | How many winner slots one worker can win. Defaults to `1`. Wins plus proofs awaiting review never exceed this number, and a worker runs one attempt at a time. Cannot exceed `accepted_submissions_limit`. |
|
|
41
42
|
| `--account_id` | `unknown` | no | | Account whose balance funds the bounty pool (`biz_` tag). Defaults to the caller's personal balance. Requires permission to move the account's funds. |
|
|
42
43
|
| `--allowed_country_codes` | `unknown` | no | | Countries whose residents can work the bounty, as ISO 3166 alpha-2 codes. Empty means worldwide. |
|
|
43
44
|
| `--business_goal_type` | `string` | no | | What the poster wants the work to achieve, declared once here. |
|
|
@@ -131,6 +132,7 @@ Update Bounty
|
|
|
131
132
|
| Flag | Type | Required | Default | Description |
|
|
132
133
|
|------|------|----------|---------|-------------|
|
|
133
134
|
| `--accepted_submissions_limit` | `number` | no | | Scheduled drafts only. Number of submissions that can be accepted (winner slots). |
|
|
135
|
+
| `--accepted_submissions_per_user_limit` | `number` | no | | How many winner slots one worker can win. Defaults to `1`. Wins plus proofs awaiting review never exceed this number, and a worker runs one attempt at a time. Cannot exceed `accepted_submissions_limit`. Editable while the bounty is still open with nothing under review. |
|
|
134
136
|
| `--allowed_country_codes` | `unknown` | no | | Replace the countries whose residents can work the bounty, as ISO 3166 alpha-2 codes. Empty means worldwide. |
|
|
135
137
|
| `--business_goal_type` | `string` | no | | What the poster wants the work to achieve, declared once here. |
|
|
136
138
|
| `--description` | `string` | no | | New full task instructions. |
|
|
@@ -35,7 +35,7 @@ Cancel Bounty Submission
|
|
|
35
35
|
|
|
36
36
|
| Name | Type | Required | Description |
|
|
37
37
|
|------|------|----------|-------------|
|
|
38
|
-
| `
|
|
38
|
+
| `id` | `string` | yes | The bounty submission to act on (`btys_` tag). |
|
|
39
39
|
|
|
40
40
|
> Confirm with the user before executing this destructive command.
|
|
41
41
|
|
|
@@ -49,7 +49,7 @@ Retrieve Bounty Submission
|
|
|
49
49
|
|
|
50
50
|
| Name | Type | Required | Description |
|
|
51
51
|
|------|------|----------|-------------|
|
|
52
|
-
| `
|
|
52
|
+
| `id` | `string` | yes | The bounty submission to act on (`btys_` tag). |
|
|
53
53
|
|
|
54
54
|
---
|
|
55
55
|
|
|
@@ -83,7 +83,7 @@ Submit Bounty Submission
|
|
|
83
83
|
|
|
84
84
|
| Name | Type | Required | Description |
|
|
85
85
|
|------|------|----------|-------------|
|
|
86
|
-
| `
|
|
86
|
+
| `id` | `string` | yes | The claimed attempt to submit for review (`btys_` tag). |
|
|
87
87
|
|
|
88
88
|
## Options
|
|
89
89
|
|
|
@@ -38,7 +38,7 @@ Retrieve Card
|
|
|
38
38
|
|
|
39
39
|
| Name | Type | Required | Description |
|
|
40
40
|
|------|------|----------|-------------|
|
|
41
|
-
| `
|
|
41
|
+
| `id` | `string` | yes | Card ID to retrieve, prefixed `icrd_`. |
|
|
42
42
|
|
|
43
43
|
## Options
|
|
44
44
|
|
|
@@ -112,7 +112,7 @@ Update Card
|
|
|
112
112
|
|
|
113
113
|
| Name | Type | Required | Description |
|
|
114
114
|
|------|------|----------|-------------|
|
|
115
|
-
| `
|
|
115
|
+
| `id` | `string` | yes | Card ID to retrieve, prefixed `icrd_`. |
|
|
116
116
|
|
|
117
117
|
## Options
|
|
118
118
|
|
|
@@ -70,7 +70,7 @@ Mirrors the filtering query params of `GET /api/v1/apps`.
|
|
|
70
70
|
|
|
71
71
|
- `app_type` `string` — Filter apps by the type of end-user they are built for. Apps of type `website` are left out unless you ask for them by name. One of `b2b_app`, `b2c_app`, `company_app`, `component`, `website`.
|
|
72
72
|
- `query` `string` — A search string matched against app names.
|
|
73
|
-
- `verified_apps_only` `boolean` — Whether to only return apps verified by Whop.
|
|
73
|
+
- `verified_apps_only` `boolean` — Whether to only return apps verified by Whop. Verified website templates — websites with a published web build — are included, even though websites are otherwise left out of app lists.
|
|
74
74
|
- `view_type` `string` — Only return apps supporting this view type, such as `dashboard` or `hub`. One of `hub`, `discover`, `dash`, `dashboard`, `analytics`, `skills`, `openapi`.
|
|
75
75
|
|
|
76
76
|
</details>
|
|
@@ -315,7 +315,7 @@ Mirrors the filtering query params of `GET /api/v1/team_members`.
|
|
|
315
315
|
|
|
316
316
|
- `created_after` `string` — Only return members added after this ISO 8601 timestamp.
|
|
317
317
|
- `created_before` `string` — Only return members added before this ISO 8601 timestamp.
|
|
318
|
-
- `role` `string` — Only return members with this role. `custom` matches members on a dashboard-managed custom role. One of `owner`, `admin`, `sales_manager`, `moderator`, `advertiser`, `app_manager`, `support`, `manager`, `custom`.
|
|
318
|
+
- `role` `string` — Only return members with this role. `custom` matches members on a dashboard-managed custom role. One of `owner`, `admin`, `sales_manager`, `moderator`, `advertiser`, `app_manager`, `support`, `manager`, `workforce`, `custom`.
|
|
319
319
|
- `status` `string` — Only return members with this status: `joined` (accepted members) or `pending` (pending invites). Both are returned by default. One of `joined`, `pending`.
|
|
320
320
|
- `user_id` `string` — Only return the membership for this user ID, prefixed `user_`.
|
|
321
321
|
|
|
@@ -54,7 +54,7 @@ Retrieve Notification
|
|
|
54
54
|
|
|
55
55
|
| Name | Type | Required | Description |
|
|
56
56
|
|------|------|----------|-------------|
|
|
57
|
-
| `
|
|
57
|
+
| `id` | `string` | yes | A notification `id` from List Notifications, or the id delivered with a push/websocket event. |
|
|
58
58
|
|
|
59
59
|
---
|
|
60
60
|
|
|
@@ -18,7 +18,7 @@ Create Payment Method Domain
|
|
|
18
18
|
| Flag | Type | Required | Default | Description |
|
|
19
19
|
|------|------|----------|---------|-------------|
|
|
20
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.example
|
|
21
|
+
| `--hostname` | `string` | yes | | Hostname to register (e.g. `checkout.shinetime.example`). |
|
|
22
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
23
|
|
|
24
24
|
> 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
|
|
|
@@ -62,7 +62,7 @@ Delete Saved Payout Method
|
|
|
62
62
|
|
|
63
63
|
| Name | Type | Required | Description |
|
|
64
64
|
|------|------|----------|-------------|
|
|
65
|
-
| `
|
|
65
|
+
| `id` | `string` | yes | Payout method ID, prefixed `potk_`. |
|
|
66
66
|
|
|
67
67
|
> Confirm with the user before executing this destructive command.
|
|
68
68
|
|
|
@@ -76,7 +76,7 @@ Retrieve Payout
|
|
|
76
76
|
|
|
77
77
|
| Name | Type | Required | Description |
|
|
78
78
|
|------|------|----------|-------------|
|
|
79
|
-
| `
|
|
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
80
|
|
|
81
81
|
## Options
|
|
82
82
|
|
|
@@ -136,7 +136,7 @@ List Supported Payout Methods
|
|
|
136
136
|
|------|------|----------|---------|-------------|
|
|
137
137
|
| `--account_id` | `string` | no | | The owning account ID (a biz_ identifier). Provide this or user_id. |
|
|
138
138
|
| `--user_id` | `string` | no | | The owning user ID (a user_ identifier). Provide this or account_id. |
|
|
139
|
-
| `--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. |
|
|
140
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. |
|
|
141
141
|
| `--currency` | `string` | no | `usd` | Currency code of the amount, for example `usd`. Only meaningful with amount. |
|
|
142
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. |
|
|
@@ -156,7 +156,7 @@ Rename Saved Payout Method
|
|
|
156
156
|
|
|
157
157
|
| Name | Type | Required | Description |
|
|
158
158
|
|------|------|----------|-------------|
|
|
159
|
-
| `
|
|
159
|
+
| `id` | `string` | yes | Payout method ID, prefixed `potk_`. |
|
|
160
160
|
|
|
161
161
|
## Options
|
|
162
162
|
|
|
@@ -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. |
|
|
@@ -17,7 +17,7 @@ Run Recommended Action
|
|
|
17
17
|
|
|
18
18
|
| Name | Type | Required | Description |
|
|
19
19
|
|------|------|----------|-------------|
|
|
20
|
-
| `
|
|
20
|
+
| `id` | `string` | yes | Chain ID from the list endpoint, e.g. `rac_seed_start_selling_9f2c1a7b04`. |
|
|
21
21
|
|
|
22
22
|
## Options
|
|
23
23
|
|
|
@@ -30,6 +30,24 @@ Run Recommended Action
|
|
|
30
30
|
|
|
31
31
|
---
|
|
32
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
|
+
|
|
33
51
|
# whop recommended-actions list
|
|
34
52
|
|
|
35
53
|
List Recommended Actions
|
|
@@ -23,7 +23,7 @@ Update setup 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
|
|
|
@@ -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
|
|
|
@@ -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
|
|