@whop/cli 0.16.0 → 0.16.2
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 +17 -3
- package/dist/index.js +6647 -15750
- package/dist/index.js.map +1 -1
- package/dist/vite-devtools-stub.d.ts +22 -0
- package/dist/vite-devtools-stub.js +19 -0
- package/dist/vite-devtools-stub.js.map +1 -0
- package/dist/vite.d.ts +17 -2
- package/dist/vite.js +30 -5
- package/dist/vite.js.map +1 -1
- package/package.json +8 -7
- package/skills/whop/SKILL.md +48 -0
- package/skills/whop/references/ads.md +43 -0
- package/skills/whop/references/formation.md +40 -0
- package/skills/whop/references/websites.md +59 -0
- package/skills/whop-accounts/SKILL.md +0 -228
- package/skills/whop-ad-campaigns/SKILL.md +0 -204
- package/skills/whop-ad-groups/SKILL.md +0 -269
- package/skills/whop-ads/SKILL.md +0 -277
- package/skills/whop-api-keys/SKILL.md +0 -126
- package/skills/whop-app-builds/SKILL.md +0 -81
- package/skills/whop-apps/SKILL.md +0 -161
- package/skills/whop-audiences/SKILL.md +0 -105
- package/skills/whop-bounties/SKILL.md +0 -145
- package/skills/whop-bounty-submissions/SKILL.md +0 -95
- package/skills/whop-cards/SKILL.md +0 -133
- package/skills/whop-checkout-configurations/SKILL.md +0 -77
- package/skills/whop-deposits/SKILL.md +0 -26
- package/skills/whop-dispute-alerts/SKILL.md +0 -42
- package/skills/whop-disputes/SKILL.md +0 -99
- package/skills/whop-events/SKILL.md +0 -105
- package/skills/whop-exports/SKILL.md +0 -379
- package/skills/whop-ledgers/SKILL.md +0 -52
- package/skills/whop-media/SKILL.md +0 -44
- package/skills/whop-members/SKILL.md +0 -64
- package/skills/whop-memberships/SKILL.md +0 -165
- package/skills/whop-notifications/SKILL.md +0 -104
- package/skills/whop-partners/SKILL.md +0 -113
- package/skills/whop-payment-method-domains/SKILL.md +0 -93
- package/skills/whop-payments/SKILL.md +0 -40
- package/skills/whop-payouts/SKILL.md +0 -167
- package/skills/whop-people/SKILL.md +0 -63
- package/skills/whop-permissions/SKILL.md +0 -21
- package/skills/whop-plans/SKILL.md +0 -165
- package/skills/whop-products/SKILL.md +0 -153
- package/skills/whop-recommended-actions/SKILL.md +0 -59
- package/skills/whop-resolution-center-cases/SKILL.md +0 -233
- package/skills/whop-setup-intents/SKILL.md +0 -40
- package/skills/whop-shipments/SKILL.md +0 -79
- package/skills/whop-social-accounts/SKILL.md +0 -128
- package/skills/whop-stats/SKILL.md +0 -65
- package/skills/whop-swaps/SKILL.md +0 -77
- package/skills/whop-team-members/SKILL.md +0 -93
- package/skills/whop-transfers/SKILL.md +0 -80
- package/skills/whop-users/SKILL.md +0 -309
- package/skills/whop-verifications/SKILL.md +0 -67
|
@@ -1,105 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: whop-audiences
|
|
3
|
-
description: Reusable targeting lists for ad groups. Run `whop audiences --help` for usage details.
|
|
4
|
-
requires_bin: whop
|
|
5
|
-
command: whop audiences
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
An Audience represents a customer list uploaded to Whop for ad targeting. Audiences belong to an account and sync to supported ad platforms as custom audiences.
|
|
9
|
-
|
|
10
|
-
Use the Audiences API to create audiences from CSV uploads, monitor processing status, and list or delete audiences for an account. Created audiences are usable for targeting after processing reaches `ready` or `partial`.
|
|
11
|
-
|
|
12
|
-
# whop audiences add_people
|
|
13
|
-
|
|
14
|
-
Add People
|
|
15
|
-
|
|
16
|
-
## Arguments
|
|
17
|
-
|
|
18
|
-
| Name | Type | Required | Description |
|
|
19
|
-
|------|------|----------|-------------|
|
|
20
|
-
| `id` | `string` | yes | Audience ID, prefixed `adaud_`. |
|
|
21
|
-
|
|
22
|
-
## Options
|
|
23
|
-
|
|
24
|
-
| Flag | Type | Required | Default | Description |
|
|
25
|
-
|------|------|----------|---------|-------------|
|
|
26
|
-
| `--file_id` | `string` | yes | | The new customer CSV — a file id (`file_...`) returned by `POST /files`. Its headers must match the audience's saved column mapping. |
|
|
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 audiences create
|
|
34
|
-
|
|
35
|
-
Create Audience
|
|
36
|
-
|
|
37
|
-
## Options
|
|
38
|
-
|
|
39
|
-
| Flag | Type | Required | Default | Description |
|
|
40
|
-
|------|------|----------|---------|-------------|
|
|
41
|
-
| `--account_id` | `string` | yes | | Account ID, prefixed `biz_`. |
|
|
42
|
-
| `--audience_type` | `string` | no | | What to create. Defaults to `custom` (CSV upload). |
|
|
43
|
-
| `--auto_refresh` | `boolean` | no | | Filter audiences only, and set only at creation. `true` (the default) rebuilds membership from the filters twice a day. `false` keeps whoever matched at creation and never rebuilds. |
|
|
44
|
-
| `--column_mapping` | `object` | no | | Custom audiences only. Maps supported identity fields to CSV column headers. Map at least one of `email` or `phone`. |
|
|
45
|
-
| `--count` | `number` | no | | Lookalikes only. Number of lookalike audiences to create (1–6). |
|
|
46
|
-
| `--file_id` | `string` | no | | Custom audiences only. The uploaded customer CSV — a file id (`file_...`) returned by `POST /files`. |
|
|
47
|
-
| `--filters` | `object` | no | | Filter audiences only. The People filters that define membership, keyed exactly as `GET /people` accepts them — for example `{"os": "iOS", "country": "US"}`. Date filters must be rolling windows — `first_seen_within_days` or `last_seen_within_days` — so the audience re-anchors on every refresh; fixed dates such as `first_seen_after` are rejected. Source values are canonical source paths (`whop:<campaign>:<group>:<ad>`, `ext:<platform>:...`, `referrer:<domain>`, `direct`), exact or with a trailing `:*` wildcard. |
|
|
48
|
-
| `--name` | `string` | no | | Audience display name. Required for custom audiences; lookalike names are generated from the source audience. |
|
|
49
|
-
| `--percentage` | `number` | no | | Lookalikes only. Total similarity reach as a whole percent (1–20), sliced evenly across `count` — must be divisible by `count`. |
|
|
50
|
-
| `--source_audience_id` | `string` | no | | Lookalikes only. The ready custom audience (`adaud_`) to build from; it needs at least 100 matched people. |
|
|
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). |
|
|
52
|
-
|
|
53
|
-
> Confirm with the user before executing this destructive command.
|
|
54
|
-
|
|
55
|
-
---
|
|
56
|
-
|
|
57
|
-
# whop audiences delete
|
|
58
|
-
|
|
59
|
-
Delete Audience
|
|
60
|
-
|
|
61
|
-
## Arguments
|
|
62
|
-
|
|
63
|
-
| Name | Type | Required | Description |
|
|
64
|
-
|------|------|----------|-------------|
|
|
65
|
-
| `id` | `string` | yes | Audience ID, prefixed `adaud_`. |
|
|
66
|
-
|
|
67
|
-
> Confirm with the user before executing this destructive command.
|
|
68
|
-
|
|
69
|
-
---
|
|
70
|
-
|
|
71
|
-
# whop audiences list
|
|
72
|
-
|
|
73
|
-
List Audiences
|
|
74
|
-
|
|
75
|
-
## Options
|
|
76
|
-
|
|
77
|
-
| Flag | Type | Required | Default | Description |
|
|
78
|
-
|------|------|----------|---------|-------------|
|
|
79
|
-
| `--account_id` | `string` | no | | Account ID, prefixed `biz_`. |
|
|
80
|
-
| `--audience_id` | `string` | no | | Audience ID, prefixed `adaud_`, used to filter the response to one audience. |
|
|
81
|
-
| `--audience_type` | `string` | no | | Filter by audience type: `custom` (uploaded lists) or `lookalike`. |
|
|
82
|
-
| `--source_type` | `string` | no | | Filter by member source: `csv_upload` (uploaded lists) or `people_filter` (automatic audiences built from saved People filters). |
|
|
83
|
-
| `--first` | `number` | no | | Number of audiences to return. Defaults to 20; maximum 100. |
|
|
84
|
-
| `--after` | `string` | no | | Cursor for the next page of audiences. |
|
|
85
|
-
|
|
86
|
-
---
|
|
87
|
-
|
|
88
|
-
# whop audiences update
|
|
89
|
-
|
|
90
|
-
Update Audience
|
|
91
|
-
|
|
92
|
-
## Arguments
|
|
93
|
-
|
|
94
|
-
| Name | Type | Required | Description |
|
|
95
|
-
|------|------|----------|-------------|
|
|
96
|
-
| `id` | `string` | yes | Audience ID, prefixed `adaud_`. |
|
|
97
|
-
|
|
98
|
-
## Options
|
|
99
|
-
|
|
100
|
-
| Flag | Type | Required | Default | Description |
|
|
101
|
-
|------|------|----------|---------|-------------|
|
|
102
|
-
| `--filters` | `object` | no | | Replaces the People filters that define membership. The whole definition is replaced rather than merged, so send every filter you want to keep — a filter you leave out stops applying. Keys and values are the ones `GET /people` accepts, such as an `os` of `iOS` or a `country` of `US`, and at least one filter is required. Date filters must be rolling windows — `first_seen_within_days` or `last_seen_within_days` — so the audience re-anchors every time it rebuilds; fixed dates such as `first_seen_after` are rejected, as is `audience_id`. An array value holds at most 500 items, and each value at most 10 KB. Only an audience with a `source_type` of `people_filter` and `auto_refresh` of `true` accepts filters: an uploaded list has no filters to replace, and with auto refresh off the audience keeps the people it matched when it was built, so create a new audience instead. |
|
|
103
|
-
| `--name` | `string` | no | | New audience display name. A blank value is ignored rather than clearing the name. |
|
|
104
|
-
|
|
105
|
-
> Confirm with the user before executing this destructive command.
|
|
@@ -1,145 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: whop-bounties
|
|
3
|
-
description: Paid tasks with reviewed submissions and escrowed rewards. Run `whop bounties --help` for usage details.
|
|
4
|
-
requires_bin: whop
|
|
5
|
-
command: whop bounties
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
A Bounty is a paid task posted by an account or user. The reward is held in escrow when the bounty publishes, workers submit proof of completed work, and each accepted submission is paid out until every winner slot fills.
|
|
9
|
-
|
|
10
|
-
Use the Bounties API to create and publish a bounty, list an account's bounties for reporting or dashboards, list the bounties a user can work or has participated in, and retrieve a single bounty by ID.
|
|
11
|
-
|
|
12
|
-
# whop bounties cancel
|
|
13
|
-
|
|
14
|
-
Cancel
|
|
15
|
-
|
|
16
|
-
## Arguments
|
|
17
|
-
|
|
18
|
-
| Name | Type | Required | Description |
|
|
19
|
-
|------|------|----------|-------------|
|
|
20
|
-
| `id` | `string` | yes | Bounty ID (`bnty_` tag). |
|
|
21
|
-
|
|
22
|
-
## Options
|
|
23
|
-
|
|
24
|
-
| Flag | Type | Required | Default | Description |
|
|
25
|
-
|------|------|----------|---------|-------------|
|
|
26
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
27
|
-
|
|
28
|
-
> Confirm with the user before executing this destructive command.
|
|
29
|
-
|
|
30
|
-
---
|
|
31
|
-
|
|
32
|
-
# whop bounties create
|
|
33
|
-
|
|
34
|
-
Create Bounty
|
|
35
|
-
|
|
36
|
-
## Options
|
|
37
|
-
|
|
38
|
-
| Flag | Type | Required | Default | Description |
|
|
39
|
-
|------|------|----------|---------|-------------|
|
|
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`. |
|
|
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. |
|
|
43
|
-
| `--allowed_country_codes` | `unknown` | no | | Countries whose residents can work the bounty, as ISO 3166 alpha-2 codes. Empty means worldwide. |
|
|
44
|
-
| `--business_goal_type` | `string` | no | | What the poster wants the work to achieve, declared once here. |
|
|
45
|
-
| `--capture_spec` | `object` | no | | Per-bounty overrides of the served capture contract. Only accepted when `business_goal_type` is `data_capture`; omitted fields keep the platform defaults, and the resulting contract is echoed back as `capture_spec` on the bounty. |
|
|
46
|
-
| `--description` | `string` | yes | | Full task instructions shown to workers. |
|
|
47
|
-
| `--experience_id` | `unknown` | no | | Experience to host the bounty in (`exp_` tag). Any visibility — public for an open bounty, private for an invited one. Required unless account_id is set, in which case the bounty anchors in that account's public forum. |
|
|
48
|
-
| `--frequency` | `string` | no | | How often the schedule creates a new bounty. Each occurrence is a separate bounty. Defaults to `once`; only applies with `publish_at`. |
|
|
49
|
-
| `--gross_reward_amount` | `number` | yes | | Gross bounty-pool amount (USD) escrowed per accepted submission, in whole dollars. Platform fees and affiliate shares are paid from this amount. |
|
|
50
|
-
| `--publish_at` | `unknown` | no | | ISO 8601 time to publish the bounty. When set, the bounty is created as a hidden draft and funded + published at this time instead of immediately. |
|
|
51
|
-
| `--publish_at_timezone` | `unknown` | no | | IANA timezone for recurring occurrences. Required when publish_at is set. |
|
|
52
|
-
| `--title` | `string` | yes | | Short name of the task shown to workers. |
|
|
53
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
54
|
-
|
|
55
|
-
> Confirm with the user before executing this destructive command.
|
|
56
|
-
|
|
57
|
-
---
|
|
58
|
-
|
|
59
|
-
# whop bounties get
|
|
60
|
-
|
|
61
|
-
Retrieve Bounty
|
|
62
|
-
|
|
63
|
-
## Arguments
|
|
64
|
-
|
|
65
|
-
| Name | Type | Required | Description |
|
|
66
|
-
|------|------|----------|-------------|
|
|
67
|
-
| `id` | `string` | yes | Bounty ID (`bnty_` tag). |
|
|
68
|
-
|
|
69
|
-
---
|
|
70
|
-
|
|
71
|
-
# whop bounties list
|
|
72
|
-
|
|
73
|
-
List Bounties
|
|
74
|
-
|
|
75
|
-
## Options
|
|
76
|
-
|
|
77
|
-
| Flag | Type | Required | Default | Description |
|
|
78
|
-
|------|------|----------|---------|-------------|
|
|
79
|
-
| `--account_id` | `string` | no | | Scope the list to this account (`biz_` tag). Requires read access to the account; account API keys may pass their own account or a connected account. |
|
|
80
|
-
| `--user_id` | `string` | no | | List the bounties this user participated in (`user_` tag). Must be the authenticated user. |
|
|
81
|
-
| `--status` | `string` | no | | Filter by lifecycle state. |
|
|
82
|
-
| `--query` | `string` | no | | Substring match on the bounty title or ID. |
|
|
83
|
-
| `--created_after` | `string` | no | | Only bounties created after this ISO 8601 timestamp. |
|
|
84
|
-
| `--created_before` | `string` | no | | Only bounties created before this ISO 8601 timestamp. |
|
|
85
|
-
| `--order` | `string` | no | | Sort field. |
|
|
86
|
-
| `--direction` | `string` | no | | Sort direction. |
|
|
87
|
-
| `--first` | `number` | no | `20` | Number of bounties to return from the start of the window. |
|
|
88
|
-
| `--after` | `string` | no | | Cursor to paginate forwards from. |
|
|
89
|
-
| `--last` | `number` | no | | Number of bounties to return from the end of the window. |
|
|
90
|
-
| `--before` | `string` | no | | Cursor to paginate backwards from. |
|
|
91
|
-
|
|
92
|
-
---
|
|
93
|
-
|
|
94
|
-
# whop bounties submissions
|
|
95
|
-
|
|
96
|
-
List Public Submissions
|
|
97
|
-
|
|
98
|
-
## Arguments
|
|
99
|
-
|
|
100
|
-
| Name | Type | Required | Description |
|
|
101
|
-
|------|------|----------|-------------|
|
|
102
|
-
| `bounty_id` | `string` | yes | The bounty whose public submissions to list (`bnty_` tag). |
|
|
103
|
-
|
|
104
|
-
## Options
|
|
105
|
-
|
|
106
|
-
| Flag | Type | Required | Default | Description |
|
|
107
|
-
|------|------|----------|---------|-------------|
|
|
108
|
-
| `--status` | `string` | no | | Filter by lifecycle state. |
|
|
109
|
-
| `--created_after` | `string` | no | | Only submissions created after this ISO 8601 timestamp. |
|
|
110
|
-
| `--created_before` | `string` | no | | Only submissions created before this ISO 8601 timestamp. |
|
|
111
|
-
| `--order` | `string` | no | | Sort field. |
|
|
112
|
-
| `--direction` | `string` | no | | Sort direction. |
|
|
113
|
-
| `--first` | `number` | no | `20` | Number of submissions to return from the start of the window. |
|
|
114
|
-
| `--after` | `string` | no | | Cursor to paginate forwards from. |
|
|
115
|
-
| `--last` | `number` | no | | Number of submissions to return from the end of the window. |
|
|
116
|
-
| `--before` | `string` | no | | Cursor to paginate backwards from. |
|
|
117
|
-
|
|
118
|
-
---
|
|
119
|
-
|
|
120
|
-
# whop bounties update
|
|
121
|
-
|
|
122
|
-
Update Bounty
|
|
123
|
-
|
|
124
|
-
## Arguments
|
|
125
|
-
|
|
126
|
-
| Name | Type | Required | Description |
|
|
127
|
-
|------|------|----------|-------------|
|
|
128
|
-
| `id` | `string` | yes | Bounty ID (`bnty_` tag). |
|
|
129
|
-
|
|
130
|
-
## Options
|
|
131
|
-
|
|
132
|
-
| Flag | Type | Required | Default | Description |
|
|
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. |
|
|
136
|
-
| `--allowed_country_codes` | `unknown` | no | | Replace the countries whose residents can work the bounty, as ISO 3166 alpha-2 codes. Empty means worldwide. |
|
|
137
|
-
| `--business_goal_type` | `string` | no | | What the poster wants the work to achieve, declared once here. |
|
|
138
|
-
| `--description` | `string` | no | | New full task instructions. |
|
|
139
|
-
| `--frequency` | `string` | no | | Scheduled drafts only. How often the schedule creates a new bounty. |
|
|
140
|
-
| `--gross_reward_amount` | `number` | no | | Scheduled drafts only. Gross bounty-pool amount (USD) escrowed per accepted submission. The escrowed total (this times accepted_submissions_limit) must stay at least $5. |
|
|
141
|
-
| `--publish_at` | `unknown` | no | | Scheduled drafts only. New ISO 8601 time to publish the draft. Must be in the future. |
|
|
142
|
-
| `--publish_at_timezone` | `unknown` | no | | Scheduled drafts only. IANA timezone for recurring occurrences. |
|
|
143
|
-
| `--title` | `string` | no | | New short name of the task. |
|
|
144
|
-
|
|
145
|
-
> Confirm with the user before executing this destructive command.
|
|
@@ -1,95 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: whop-bounty-submissions
|
|
3
|
-
description: Work submitted to a bounty, from attempt to payout. Run `whop bounty-submissions --help` for usage details.
|
|
4
|
-
requires_bin: whop
|
|
5
|
-
command: whop bounty-submissions
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
A Bounty Submission is one worker's attempt on a bounty. It starts as an in-progress attempt, enters the review queue when proof is submitted, and ends approved (paid from the bounty's escrowed pool) or denied.
|
|
9
|
-
|
|
10
|
-
Use the Bounty Submissions API to submit proof of completed work to a bounty, list the submissions you authored, and review the submissions on your bounties — across every bounty or narrowed to one.
|
|
11
|
-
|
|
12
|
-
# whop bounty-submissions create
|
|
13
|
-
|
|
14
|
-
Create Bounty Submission
|
|
15
|
-
|
|
16
|
-
## Options
|
|
17
|
-
|
|
18
|
-
| Flag | Type | Required | Default | Description |
|
|
19
|
-
|------|------|----------|---------|-------------|
|
|
20
|
-
| `--affiliate_code` | `unknown` | no | | Affiliate code crediting the referrer, when the worker arrived through one. |
|
|
21
|
-
| `--bounty_id` | `string` | yes | | The bounty to submit to (`bnty_` tag). |
|
|
22
|
-
| `--deliverable` | `unknown` | no | | The submitted work. Combine `urls`, `file_ids`, and `caption` freely; at least one link or file is required. |
|
|
23
|
-
| `--metadata` | `unknown` | no | | Optional capture metadata describing where and how the footage was recorded. Persisted on the submission. On a `data_capture` bounty every field except `fov` is required whenever metadata is provided. |
|
|
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 bounty-submissions delete
|
|
31
|
-
|
|
32
|
-
Cancel Bounty Submission
|
|
33
|
-
|
|
34
|
-
## Arguments
|
|
35
|
-
|
|
36
|
-
| Name | Type | Required | Description |
|
|
37
|
-
|------|------|----------|-------------|
|
|
38
|
-
| `id` | `string` | yes | The bounty submission to act on (`btys_` tag). |
|
|
39
|
-
|
|
40
|
-
> Confirm with the user before executing this destructive command.
|
|
41
|
-
|
|
42
|
-
---
|
|
43
|
-
|
|
44
|
-
# whop bounty-submissions get
|
|
45
|
-
|
|
46
|
-
Retrieve Bounty Submission
|
|
47
|
-
|
|
48
|
-
## Arguments
|
|
49
|
-
|
|
50
|
-
| Name | Type | Required | Description |
|
|
51
|
-
|------|------|----------|-------------|
|
|
52
|
-
| `id` | `string` | yes | The bounty submission to act on (`btys_` tag). |
|
|
53
|
-
|
|
54
|
-
---
|
|
55
|
-
|
|
56
|
-
# whop bounty-submissions list
|
|
57
|
-
|
|
58
|
-
List Bounty Submissions
|
|
59
|
-
|
|
60
|
-
## Options
|
|
61
|
-
|
|
62
|
-
| Flag | Type | Required | Default | Description |
|
|
63
|
-
|------|------|----------|---------|-------------|
|
|
64
|
-
| `--account_id` | `string` | no | | Scope the list to submissions on this account's bounties (`biz_` tag). Requires read access to the account. |
|
|
65
|
-
| `--bounty_id` | `string` | no | | Only submissions on this bounty (`bnty_` tag). |
|
|
66
|
-
| `--status` | `string` | no | | Filter by lifecycle state. |
|
|
67
|
-
| `--created_after` | `string` | no | | Only submissions created after this ISO 8601 timestamp. |
|
|
68
|
-
| `--created_before` | `string` | no | | Only submissions created before this ISO 8601 timestamp. |
|
|
69
|
-
| `--order` | `string` | no | | Sort field. |
|
|
70
|
-
| `--direction` | `string` | no | | Sort direction. |
|
|
71
|
-
| `--first` | `number` | no | `20` | Number of submissions to return from the start of the window. |
|
|
72
|
-
| `--after` | `string` | no | | Cursor to paginate forwards from. |
|
|
73
|
-
| `--last` | `number` | no | | Number of submissions to return from the end of the window. |
|
|
74
|
-
| `--before` | `string` | no | | Cursor to paginate backwards from. |
|
|
75
|
-
|
|
76
|
-
---
|
|
77
|
-
|
|
78
|
-
# whop bounty-submissions submit
|
|
79
|
-
|
|
80
|
-
Submit Bounty Submission
|
|
81
|
-
|
|
82
|
-
## Arguments
|
|
83
|
-
|
|
84
|
-
| Name | Type | Required | Description |
|
|
85
|
-
|------|------|----------|-------------|
|
|
86
|
-
| `id` | `string` | yes | The claimed attempt to submit for review (`btys_` tag). |
|
|
87
|
-
|
|
88
|
-
## Options
|
|
89
|
-
|
|
90
|
-
| Flag | Type | Required | Default | Description |
|
|
91
|
-
|------|------|----------|---------|-------------|
|
|
92
|
-
| `--deliverable` | `unknown` | no | | Work to attach to the submission. Combine `urls`, `file_ids`, and `caption` freely; all are optional. |
|
|
93
|
-
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
94
|
-
|
|
95
|
-
> Confirm with the user before executing this destructive command.
|
|
@@ -1,133 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: whop-cards
|
|
3
|
-
description: Issue cards that spend from a balance. Run `whop cards --help` for usage details.
|
|
4
|
-
requires_bin: whop
|
|
5
|
-
command: whop cards
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
Cards represent Whop-issued virtual payment cards that spend from an account or user balance. Cards can be assigned to cardholders and configured with spending limits for controlled spending.
|
|
9
|
-
|
|
10
|
-
Use the Cards API to issue cards, list cards for an account or user, and retrieve active card details such as the card number and CVC.
|
|
11
|
-
|
|
12
|
-
# whop cards create
|
|
13
|
-
|
|
14
|
-
Create Card
|
|
15
|
-
|
|
16
|
-
## Options
|
|
17
|
-
|
|
18
|
-
| Flag | Type | Required | Default | Description |
|
|
19
|
-
|------|------|----------|---------|-------------|
|
|
20
|
-
| `--account_id` | `string` | no | | The owning account ID (a biz_ identifier). Provide this or user_id. |
|
|
21
|
-
| `--assigned_user_id` | `string` | no | | The account member (a user_ identifier) to assign the card to. Required for business card issuing accounts. |
|
|
22
|
-
| `--name` | `string` | no | | A display name for the card. |
|
|
23
|
-
| `--spend_limit` | `number` | no | | Spending limit amount, in dollars. |
|
|
24
|
-
| `--spend_limit_frequency` | `string` | no | | The window the spend limit applies to. |
|
|
25
|
-
| `--transaction_limit` | `number` | no | | Per-transaction limit amount, in dollars. |
|
|
26
|
-
| `--user_id` | `string` | no | | The owning user ID (a user_ identifier). Provide this or account_id. |
|
|
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 cards get
|
|
34
|
-
|
|
35
|
-
Retrieve Card
|
|
36
|
-
|
|
37
|
-
## Arguments
|
|
38
|
-
|
|
39
|
-
| Name | Type | Required | Description |
|
|
40
|
-
|------|------|----------|-------------|
|
|
41
|
-
| `id` | `string` | yes | Card ID to retrieve, prefixed `icrd_`. |
|
|
42
|
-
|
|
43
|
-
## Options
|
|
44
|
-
|
|
45
|
-
| Flag | Type | Required | Default | Description |
|
|
46
|
-
|------|------|----------|---------|-------------|
|
|
47
|
-
| `--account_id` | `string` | no | | The owning account ID (a biz_ identifier). Provide this or user_id. |
|
|
48
|
-
| `--user_id` | `string` | no | | The owning user ID (a user_ identifier). Provide this or account_id. |
|
|
49
|
-
|
|
50
|
-
---
|
|
51
|
-
|
|
52
|
-
# whop cards get-transaction
|
|
53
|
-
|
|
54
|
-
Retrieve Card Transaction
|
|
55
|
-
|
|
56
|
-
## Arguments
|
|
57
|
-
|
|
58
|
-
| Name | Type | Required | Description |
|
|
59
|
-
|------|------|----------|-------------|
|
|
60
|
-
| `id` | `string` | yes | The card transaction ID, prefixed `citx_`. |
|
|
61
|
-
|
|
62
|
-
## Options
|
|
63
|
-
|
|
64
|
-
| Flag | Type | Required | Default | Description |
|
|
65
|
-
|------|------|----------|---------|-------------|
|
|
66
|
-
| `--account_id` | `string` | no | | The account that owns the transaction, prefixed `biz_`. Defaults to the credential's account. |
|
|
67
|
-
|
|
68
|
-
---
|
|
69
|
-
|
|
70
|
-
# whop cards list
|
|
71
|
-
|
|
72
|
-
List Cards
|
|
73
|
-
|
|
74
|
-
## Options
|
|
75
|
-
|
|
76
|
-
| Flag | Type | Required | Default | Description |
|
|
77
|
-
|------|------|----------|---------|-------------|
|
|
78
|
-
| `--account_id` | `string` | no | | The owning account ID (a biz_ identifier). Provide this or user_id. |
|
|
79
|
-
| `--user_id` | `string` | no | | The owning user ID (a user_ identifier). Provide this or account_id. |
|
|
80
|
-
|
|
81
|
-
---
|
|
82
|
-
|
|
83
|
-
# whop cards transactions
|
|
84
|
-
|
|
85
|
-
List Card Transactions
|
|
86
|
-
|
|
87
|
-
## Options
|
|
88
|
-
|
|
89
|
-
| Flag | Type | Required | Default | Description |
|
|
90
|
-
|------|------|----------|---------|-------------|
|
|
91
|
-
| `--account_id` | `string` | no | | The account whose card transactions to list, prefixed `biz_`. Defaults to the credential's account. |
|
|
92
|
-
| `--transaction_ids` | `array` | no | | Return only these card transactions, each prefixed `citx_`. Repeat the parameter, or pass one comma-separated value. |
|
|
93
|
-
| `--card_id` | `array` | no | | Return only transactions charged to these cards, each prefixed `icrd_`. |
|
|
94
|
-
| `--cardholder_id` | `array` | no | | Return only transactions on cards assigned to these users, each prefixed `user_`. |
|
|
95
|
-
| `--status` | `string` | no | | Return only transactions with this status. |
|
|
96
|
-
| `--created_after` | `string` | no | | Return only transactions authorized at or after this ISO 8601 timestamp. |
|
|
97
|
-
| `--created_before` | `string` | no | | Return only transactions authorized at or before this ISO 8601 timestamp. |
|
|
98
|
-
| `--order` | `string` | no | | The field to sort by. Defaults to `created_at`. |
|
|
99
|
-
| `--direction` | `string` | no | | The sort direction. Defaults to `desc`. |
|
|
100
|
-
| `--first` | `number` | no | | The number of card transactions to return. |
|
|
101
|
-
| `--after` | `string` | no | | A cursor; returns card transactions after this position. |
|
|
102
|
-
| `--last` | `number` | no | | The number of card transactions to return, counting back from the end. |
|
|
103
|
-
| `--before` | `string` | no | | A cursor; returns card transactions before this position. |
|
|
104
|
-
|
|
105
|
-
---
|
|
106
|
-
|
|
107
|
-
# whop cards update
|
|
108
|
-
|
|
109
|
-
Update Card
|
|
110
|
-
|
|
111
|
-
## Arguments
|
|
112
|
-
|
|
113
|
-
| Name | Type | Required | Description |
|
|
114
|
-
|------|------|----------|-------------|
|
|
115
|
-
| `id` | `string` | yes | Card ID to retrieve, prefixed `icrd_`. |
|
|
116
|
-
|
|
117
|
-
## Options
|
|
118
|
-
|
|
119
|
-
| Flag | Type | Required | Default | Description |
|
|
120
|
-
|------|------|----------|---------|-------------|
|
|
121
|
-
| `--account_id` | `string` | no | | The owning account ID (a biz_ identifier). Provide this or user_id. |
|
|
122
|
-
| `--billing` | `object` | no | | New billing address. Requires line1, city, region, postal_code, and country_code. On an invited card, passing billing alone (as the invited user) completes onboarding and starts card provisioning. |
|
|
123
|
-
| `--canceled` | `boolean` | no | | Pass `true` to permanently cancel the card. A canceled card cannot be uncanceled. Cannot be combined with other fields. |
|
|
124
|
-
| `--frozen` | `boolean` | no | | Pass `true` to freeze the card, `false` to unfreeze it. The assigned cardholder may freeze their own card without the payout:account:update scope. |
|
|
125
|
-
| `--name` | `string` | no | | A display name for the card. |
|
|
126
|
-
| `--pin` | `string` | no | | New 4-digit PIN. Can only be set on a card assigned to the acting user, who may set it without the payout:account:update scope. |
|
|
127
|
-
| `--remove_limit` | `boolean` | no | | Pass `true` to remove the spending limit (make the card unlimited). |
|
|
128
|
-
| `--spend_limit` | `number` | no | | Spending limit amount, in dollars. |
|
|
129
|
-
| `--spend_limit_frequency` | `string` | no | | The window the spend limit applies to. |
|
|
130
|
-
| `--transaction_limit` | `number` | no | | Per-transaction limit amount, in dollars. |
|
|
131
|
-
| `--user_id` | `string` | no | | The owning user ID (a user_ identifier). Provide this or account_id. |
|
|
132
|
-
|
|
133
|
-
> Confirm with the user before executing this destructive command.
|
|
@@ -1,77 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: whop-checkout-configurations
|
|
3
|
-
description: Turn a plan into a shareable, prefilled checkout link. Run `whop checkout-configurations --help` for usage details.
|
|
4
|
-
requires_bin: whop
|
|
5
|
-
command: whop checkout-configurations
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
A Checkout Configuration is a reusable checkout link owned by an account. In `payment` mode it sells a specific plan; in `setup` mode it collects and saves payment details without charging. Each configuration can also override which payment methods are accepted and how 3D Secure is enforced for that checkout.
|
|
9
|
-
|
|
10
|
-
Use the Checkout Configurations API to create checkout links for an existing or inline plan, list configurations for an account, retrieve the configuration behind a checkout URL, and delete links that should no longer be used.
|
|
11
|
-
|
|
12
|
-
# whop checkout-configurations create
|
|
13
|
-
|
|
14
|
-
Create a checkout configuration
|
|
15
|
-
|
|
16
|
-
## Options
|
|
17
|
-
|
|
18
|
-
| Flag | Type | Required | Default | Description |
|
|
19
|
-
|------|------|----------|---------|-------------|
|
|
20
|
-
| `--account_id` | `string` | no | | Account ID, prefixed `biz_`. |
|
|
21
|
-
| `--affiliate_code` | `unknown` | no | | Affiliate code to apply to the checkout. |
|
|
22
|
-
| `--currency` | `unknown` | no | | Currency used for setup-mode payment method availability. |
|
|
23
|
-
| `--metadata` | `unknown` | no | | Custom key-value metadata copied to payments and memberships. |
|
|
24
|
-
| `--mode` | `string` | no | | Controls whether checkout charges the buyer immediately or saves payment details for later. Defaults to `payment`. |
|
|
25
|
-
| `--payment_method_configuration` | `unknown` | no | | Payment method overrides for this checkout. `null` uses the plan or platform defaults. |
|
|
26
|
-
| `--plan` | `unknown` | no | | Plan attributes used to create or find a plan for this checkout configuration. Mutually exclusive with `plan_id`. |
|
|
27
|
-
| `--plan_id` | `unknown` | no | | Existing plan ID, prefixed `plan_`. Mutually exclusive with `plan`. |
|
|
28
|
-
| `--redirect_url` | `unknown` | no | | URL customers are sent to after checkout. |
|
|
29
|
-
| `--three_ds_level` | `unknown` | no | | 3D Secure behavior for this checkout. |
|
|
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). |
|
|
31
|
-
|
|
32
|
-
> Confirm with the user before executing this destructive command.
|
|
33
|
-
|
|
34
|
-
---
|
|
35
|
-
|
|
36
|
-
# whop checkout-configurations delete
|
|
37
|
-
|
|
38
|
-
Delete a checkout configuration
|
|
39
|
-
|
|
40
|
-
## Arguments
|
|
41
|
-
|
|
42
|
-
| Name | Type | Required | Description |
|
|
43
|
-
|------|------|----------|-------------|
|
|
44
|
-
| `id` | `string` | yes | The ID of the checkout configuration. |
|
|
45
|
-
|
|
46
|
-
> Confirm with the user before executing this destructive command.
|
|
47
|
-
|
|
48
|
-
---
|
|
49
|
-
|
|
50
|
-
# whop checkout-configurations get
|
|
51
|
-
|
|
52
|
-
Retrieve a checkout configuration
|
|
53
|
-
|
|
54
|
-
## Arguments
|
|
55
|
-
|
|
56
|
-
| Name | Type | Required | Description |
|
|
57
|
-
|------|------|----------|-------------|
|
|
58
|
-
| `id` | `string` | yes | The ID of the checkout configuration. |
|
|
59
|
-
|
|
60
|
-
---
|
|
61
|
-
|
|
62
|
-
# whop checkout-configurations list
|
|
63
|
-
|
|
64
|
-
List checkout configurations
|
|
65
|
-
|
|
66
|
-
## Options
|
|
67
|
-
|
|
68
|
-
| Flag | Type | Required | Default | Description |
|
|
69
|
-
|------|------|----------|---------|-------------|
|
|
70
|
-
| `--account_id` | `string` | no | | Account ID, prefixed `biz_`. |
|
|
71
|
-
| `--plan_id` | `string` | no | | Only return checkout configurations for this plan ID, prefixed `plan_`. |
|
|
72
|
-
| `--created_before` | `string` | no | | Only return checkout configurations created before this ISO 8601 timestamp. |
|
|
73
|
-
| `--created_after` | `string` | no | | Only return checkout configurations created after this ISO 8601 timestamp. |
|
|
74
|
-
| `--order` | `string` | no | | Field used to sort checkout configurations. |
|
|
75
|
-
| `--direction` | `string` | no | | Sort direction. Defaults to `desc`. |
|
|
76
|
-
| `--first` | `number` | no | | Number of checkout configurations to return. |
|
|
77
|
-
| `--after` | `string` | no | | Cursor for the next page of results. |
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: whop-deposits
|
|
3
|
-
description: Add funds to a balance. Run `whop deposits --help` for usage details.
|
|
4
|
-
requires_bin: whop
|
|
5
|
-
command: whop deposits
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
Deposits describe ways to add funds to an account balance, including hosted deposit pages, bank deposit instructions, and supported crypto wallet addresses.
|
|
9
|
-
|
|
10
|
-
Use the Deposits API to create deposit instructions for an account.
|
|
11
|
-
|
|
12
|
-
# whop deposits create
|
|
13
|
-
|
|
14
|
-
Create Deposit
|
|
15
|
-
|
|
16
|
-
## Options
|
|
17
|
-
|
|
18
|
-
| Flag | Type | Required | Default | Description |
|
|
19
|
-
|------|------|----------|---------|-------------|
|
|
20
|
-
| `--amount` | `number` | no | | Amount to prefill on hosted deposit page. |
|
|
21
|
-
| `--destination` | `unknown` | yes | | Destination account ID or wallet address. Object form is supported for compatibility. Any business resolves by its account ID without authentication; a user account resolves only for that same authenticated user. |
|
|
22
|
-
| `--metadata` | `object` | no | | Metadata to include with the deposit response. |
|
|
23
|
-
| `--network` | `unknown` | no | | Destination network override. Defaults to the destination wallet's own network. |
|
|
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.
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: whop-dispute-alerts
|
|
3
|
-
description: Issuer warnings that arrive before a chargeback does. Run `whop dispute-alerts --help` for usage details.
|
|
4
|
-
requires_bin: whop
|
|
5
|
-
command: whop dispute-alerts
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
A Dispute alert is an early warning from a card issuer that a settled payment is being questioned, ahead of any chargeback. `type` separates fraud reports (`early_fraud_warning`), pre-dispute notices (`dispute_alert`), and Visa RDR cases the network already closed by refunding (`rapid_dispute_resolution`).
|
|
9
|
-
|
|
10
|
-
Use the Dispute alerts API to list alerts for an account, filter them by type or payment, and read `actionable` to see whether refunding can still avoid the chargeback.
|
|
11
|
-
|
|
12
|
-
# whop dispute-alerts get
|
|
13
|
-
|
|
14
|
-
Retrieve Dispute Alert
|
|
15
|
-
|
|
16
|
-
## Arguments
|
|
17
|
-
|
|
18
|
-
| Name | Type | Required | Description |
|
|
19
|
-
|------|------|----------|-------------|
|
|
20
|
-
| `id` | `string` | yes | The dispute alert ID, prefixed `dspa_`. |
|
|
21
|
-
|
|
22
|
-
---
|
|
23
|
-
|
|
24
|
-
# whop dispute-alerts list
|
|
25
|
-
|
|
26
|
-
List Dispute Alerts
|
|
27
|
-
|
|
28
|
-
## Options
|
|
29
|
-
|
|
30
|
-
| Flag | Type | Required | Default | Description |
|
|
31
|
-
|------|------|----------|---------|-------------|
|
|
32
|
-
| `--account_id` | `string` | no | | Only alerts on this account's payments (`biz_` tag). Omit it to cover every account you can read. |
|
|
33
|
-
| `--payment_id` | `string` | no | | Only alerts on this payment (`pay_` tag). A payment can carry several. |
|
|
34
|
-
| `--type` | `string` | no | | Only alerts of this kind. `early_fraud_warning` for issuer fraud reports, `dispute_alert` for pre-dispute notices, `rapid_dispute_resolution` for Visa RDR cases the network already closed. |
|
|
35
|
-
| `--first` | `number` | no | | The number of alerts to return (default 20, max 100). |
|
|
36
|
-
| `--after` | `string` | no | | A cursor; returns alerts after this position. |
|
|
37
|
-
| `--last` | `number` | no | | The number of alerts to return from the end of the range. |
|
|
38
|
-
| `--before` | `string` | no | | A cursor; returns alerts before this position. |
|
|
39
|
-
| `--order` | `string` | no | | The field to sort alerts by. |
|
|
40
|
-
| `--direction` | `string` | no | | Sort direction. |
|
|
41
|
-
| `--created_before` | `string` | no | | Only alerts Whop received before this ISO 8601 timestamp. |
|
|
42
|
-
| `--created_after` | `string` | no | | Only alerts Whop received after this ISO 8601 timestamp. |
|