@whop/cli 0.14.0 → 0.14.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 +2 -2
- package/dist/index.js +25130 -10229
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
- package/skills/whop-accounts/SKILL.md +195 -15
- package/skills/whop-ad-campaigns/SKILL.md +193 -15
- package/skills/whop-ad-groups/SKILL.md +258 -16
- package/skills/whop-ads/SKILL.md +190 -14
- package/skills/whop-api-keys/SKILL.md +112 -12
- package/skills/whop-app-builds/SKILL.md +68 -8
- package/skills/whop-apps/SKILL.md +135 -12
- package/skills/whop-audiences/SKILL.md +71 -8
- package/skills/whop-bounties/SKILL.md +104 -9
- package/skills/whop-bounty-submissions/SKILL.md +82 -9
- package/skills/whop-cards/SKILL.md +120 -8
- package/skills/whop-checkout-configurations/SKILL.md +64 -8
- package/skills/whop-deposits/SKILL.md +13 -5
- package/skills/whop-disputes/SKILL.md +86 -9
- package/skills/whop-events/SKILL.md +90 -8
- package/skills/whop-exports/SKILL.md +329 -7
- package/skills/whop-ledgers/SKILL.md +38 -6
- package/skills/whop-media/SKILL.md +28 -7
- package/skills/whop-members/SKILL.md +51 -6
- package/skills/whop-memberships/SKILL.md +137 -13
- package/skills/whop-notifications/SKILL.md +91 -12
- package/skills/whop-partners/SKILL.md +102 -12
- package/skills/whop-payouts/SKILL.md +130 -9
- package/skills/whop-people/SKILL.md +50 -6
- package/skills/whop-permissions/SKILL.md +8 -5
- package/skills/whop-plans/SKILL.md +152 -12
- package/skills/whop-products/SKILL.md +141 -13
- package/skills/whop-resolution-center-cases/SKILL.md +222 -17
- package/skills/whop-shipments/SKILL.md +66 -8
- package/skills/whop-social-accounts/SKILL.md +112 -11
- package/skills/whop-stats/SKILL.md +50 -6
- package/skills/whop-swaps/SKILL.md +63 -8
- package/skills/whop-team-members/SKILL.md +80 -9
- package/skills/whop-transfers/SKILL.md +67 -8
- package/skills/whop-users/SKILL.md +271 -18
- package/skills/whop-verifications/SKILL.md +51 -9
|
@@ -9,13 +9,69 @@ A Checkout Configuration is a reusable checkout link owned by an account. In `pa
|
|
|
9
9
|
|
|
10
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
11
|
|
|
12
|
-
|
|
12
|
+
# whop checkout-configurations create
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
|---------|-------------|
|
|
16
|
-
| `whop checkout-configurations list` | List checkout configurations |
|
|
17
|
-
| `whop checkout-configurations create` | Create a checkout configuration |
|
|
18
|
-
| `whop checkout-configurations delete` | Delete a checkout configuration |
|
|
19
|
-
| `whop checkout-configurations get` | Retrieve a checkout configuration |
|
|
14
|
+
Create a checkout configuration
|
|
20
15
|
|
|
21
|
-
|
|
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. |
|
|
@@ -9,10 +9,18 @@ Deposits describe ways to add funds to an account balance, including hosted depo
|
|
|
9
9
|
|
|
10
10
|
Use the Deposits API to create deposit instructions for an account.
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
# whop deposits create
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
|---------|-------------|
|
|
16
|
-
| `whop deposits create` | Create Deposit |
|
|
14
|
+
Create Deposit
|
|
17
15
|
|
|
18
|
-
|
|
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.
|
|
@@ -9,14 +9,91 @@ A Dispute is a chargeback a customer files against a payment through their bank,
|
|
|
9
9
|
|
|
10
10
|
Disputes are opened by the customer's bank, never through the API, so you can read them but not create or delete them. Use the Disputes API to list and filter disputes, summarize them by status and currency for a queue view, edit the evidence packet while the dispute is still contestable, and submit that evidence for review.
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
# whop disputes get
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
|---------|-------------|
|
|
16
|
-
| `whop disputes list` | List Disputes |
|
|
17
|
-
| `whop disputes summary` | Retrieve Dispute Summary |
|
|
18
|
-
| `whop disputes get` | Retrieve Dispute |
|
|
19
|
-
| `whop disputes update` | Update Dispute |
|
|
20
|
-
| `whop disputes submit` | Submit Dispute |
|
|
14
|
+
Retrieve Dispute
|
|
21
15
|
|
|
22
|
-
|
|
16
|
+
## Arguments
|
|
17
|
+
|
|
18
|
+
| Name | Type | Required | Description |
|
|
19
|
+
|------|------|----------|-------------|
|
|
20
|
+
| `id` | `string` | yes | The dispute ID (`dspt_` tag). |
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
# whop disputes list
|
|
25
|
+
|
|
26
|
+
List Disputes
|
|
27
|
+
|
|
28
|
+
## Options
|
|
29
|
+
|
|
30
|
+
| Flag | Type | Required | Default | Description |
|
|
31
|
+
|------|------|----------|---------|-------------|
|
|
32
|
+
| `--account_id` | `string` | no | | Only disputes filed against this account (`biz_` tag). Omit it to cover every account you can read. |
|
|
33
|
+
| `--first` | `number` | no | | The number of disputes to return (default 20, max 100). |
|
|
34
|
+
| `--after` | `string` | no | | A cursor; returns disputes after this position. |
|
|
35
|
+
| `--last` | `number` | no | | The number of disputes to return from the end of the range. |
|
|
36
|
+
| `--before` | `string` | no | | A cursor; returns disputes before this position. |
|
|
37
|
+
| `--order` | `string` | no | | The field to sort disputes by. |
|
|
38
|
+
| `--direction` | `string` | no | | Sort direction. |
|
|
39
|
+
| `--status` | `array` | no | | Only disputes in these statuses. Repeat the parameter to pass several — one paginated list covers all of them. Covers both chargebacks and inquiries at each stage. |
|
|
40
|
+
| `--currency` | `string` | no | | Only disputes in this three-letter ISO currency. |
|
|
41
|
+
| `--created_before` | `string` | no | | Only disputes opened before this ISO 8601 timestamp. |
|
|
42
|
+
| `--created_after` | `string` | no | | Only disputes opened after this ISO 8601 timestamp. |
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
# whop disputes submit
|
|
47
|
+
|
|
48
|
+
Submit Dispute
|
|
49
|
+
|
|
50
|
+
## Arguments
|
|
51
|
+
|
|
52
|
+
| Name | Type | Required | Description |
|
|
53
|
+
|------|------|----------|-------------|
|
|
54
|
+
| `id` | `string` | yes | The dispute ID (`dspt_` tag). |
|
|
55
|
+
|
|
56
|
+
## Options
|
|
57
|
+
|
|
58
|
+
| Flag | Type | Required | Default | Description |
|
|
59
|
+
|------|------|----------|---------|-------------|
|
|
60
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
61
|
+
|
|
62
|
+
> Confirm with the user before executing this destructive command.
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
# whop disputes summary
|
|
67
|
+
|
|
68
|
+
Retrieve Dispute Summary
|
|
69
|
+
|
|
70
|
+
## Options
|
|
71
|
+
|
|
72
|
+
| Flag | Type | Required | Default | Description |
|
|
73
|
+
|------|------|----------|---------|-------------|
|
|
74
|
+
| `--groups` | `array` | no | | Which breakdowns to return, keyed by these names under `groups`. Repeat the parameter to ask for several; omit it for all of them. |
|
|
75
|
+
| `--account_id` | `string` | no | | Only disputes filed against this account (`biz_` tag). Omit it to cover every account you can read. |
|
|
76
|
+
| `--status` | `array` | no | | Only disputes in these statuses. Repeat the parameter to pass several. |
|
|
77
|
+
| `--currency` | `string` | no | | Only disputes in this three-letter ISO currency. |
|
|
78
|
+
| `--created_before` | `string` | no | | Only disputes opened before this ISO 8601 timestamp. |
|
|
79
|
+
| `--created_after` | `string` | no | | Only disputes opened after this ISO 8601 timestamp. |
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
# whop disputes update
|
|
84
|
+
|
|
85
|
+
Update Dispute
|
|
86
|
+
|
|
87
|
+
## Arguments
|
|
88
|
+
|
|
89
|
+
| Name | Type | Required | Description |
|
|
90
|
+
|------|------|----------|-------------|
|
|
91
|
+
| `id` | `string` | yes | The dispute ID (`dspt_` tag). |
|
|
92
|
+
|
|
93
|
+
## Options
|
|
94
|
+
|
|
95
|
+
| Flag | Type | Required | Default | Description |
|
|
96
|
+
|------|------|----------|---------|-------------|
|
|
97
|
+
| `--evidence` | `object` | no | | The evidence packet to send to the processor. Only the fields you provide are changed. |
|
|
98
|
+
|
|
99
|
+
> Confirm with the user before executing this destructive command.
|
|
@@ -11,13 +11,95 @@ Use the Events API to send new tracking events, list recent identity-linked even
|
|
|
11
11
|
|
|
12
12
|
Events are only as good as the pixel sending them, so [Validate Pixel](https://docs.whop.com/api-reference/beta/events/validate-pixel) answers whether an account's pixel is working: it reads the events the pixel has sent, and when you pass a `url` whose page hasn't sent any lately, it fetches that page and looks for the pixel in its source. Use it before launching an ad to confirm its destination is tracked, or in a setup flow to tell a merchant whether their install is live.
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
# whop events create
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
|---------|-------------|
|
|
18
|
-
| `whop events list` | List Events |
|
|
19
|
-
| `whop events create` | Create Event |
|
|
20
|
-
| `whop events pulse` | Retrieve the pulse feed |
|
|
21
|
-
| `whop events validate_pixel` | Validate Pixel |
|
|
16
|
+
Create Event
|
|
22
17
|
|
|
23
|
-
|
|
18
|
+
## Options
|
|
19
|
+
|
|
20
|
+
| Flag | Type | Required | Default | Description |
|
|
21
|
+
|------|------|----------|---------|-------------|
|
|
22
|
+
| `--account_id` | `string` | yes | | The account to associate with this event. |
|
|
23
|
+
| `--action_source` | `unknown` | no | | Where the event originated. |
|
|
24
|
+
| `--context` | `unknown` | no | | Tracking and attribution context. |
|
|
25
|
+
| `--currency` | `unknown` | no | | ISO 4217 currency code. |
|
|
26
|
+
| `--custom_name` | `unknown` | no | | Custom event name when event_name is 'custom'. Maximum 35 chars for this value. |
|
|
27
|
+
| `--duration` | `number` | no | | For 'leave' events: milliseconds the visitor spent on the page. |
|
|
28
|
+
| `--event_id` | `unknown` | no | | Client-provided identifier for deduplication. Generated if omitted. |
|
|
29
|
+
| `--event_name` | `string` | yes | | The type of event.
|
|
30
|
+
|
|
31
|
+
Use a standard event (lead, submit_application, contact, complete_registration, schedule, view_content, add_to_cart) or pass your own name directly for a custom event. |
|
|
32
|
+
| `--event_time` | `unknown` | no | | When the event occurred. Defaults to now. |
|
|
33
|
+
| `--plan_id` | `unknown` | no | | The plan associated with the event. |
|
|
34
|
+
| `--product_id` | `unknown` | no | | The product associated with the event. |
|
|
35
|
+
| `--referrer_url` | `unknown` | no | | The referring URL. |
|
|
36
|
+
| `--resumed` | `boolean` | no | | For 'page' events: true when the page was restored from the back/forward cache. |
|
|
37
|
+
| `--source` | `unknown` | no | | For 'identify' events: where the identity was captured (url, form, manual, iframe). |
|
|
38
|
+
| `--title` | `unknown` | no | | For 'page' events: the document title. |
|
|
39
|
+
| `--url` | `unknown` | no | | The URL where the event occurred. |
|
|
40
|
+
| `--user` | `unknown` | no | | User identity and profile data. |
|
|
41
|
+
| `--value` | `number` | no | | Monetary value associated with the event. |
|
|
42
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
43
|
+
|
|
44
|
+
> Confirm with the user before executing this destructive command.
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
# whop events list
|
|
49
|
+
|
|
50
|
+
List Events
|
|
51
|
+
|
|
52
|
+
## Options
|
|
53
|
+
|
|
54
|
+
| Flag | Type | Required | Default | Description |
|
|
55
|
+
|------|------|----------|---------|-------------|
|
|
56
|
+
| `--identifier` | `string` | no | | Any hard identifier of the person: a person ID (prsn_*), user ID, email, phone number, or a tracking cookie value (wuid, anonymous ID, fbp/fbc/ttp/ga). Omit to list recent events for the account. |
|
|
57
|
+
| `--account_id` | `string` | no | | Account ID, prefixed `biz_`. Optional for account API keys; required for credentials that can access multiple accounts. |
|
|
58
|
+
| `--from` | `string` | no | | Start of the time range as an ISO 8601 timestamp. Required when identifier is omitted. |
|
|
59
|
+
| `--to` | `string` | no | | End of the time range as an ISO 8601 timestamp. Required when identifier is omitted; otherwise defaults to now. |
|
|
60
|
+
| `--first` | `number` | no | | The number of events to return. |
|
|
61
|
+
| `--after` | `string` | no | | A cursor for fetching events after a previous page. |
|
|
62
|
+
| `--before` | `string` | no | | A cursor for fetching events before a later page. |
|
|
63
|
+
| `--direction` | `string` | no | | The order events are returned in by time. Defaults to desc (most recent first); asc reads a journey forwards from where it starts. after and before always page forwards and backwards through that order. |
|
|
64
|
+
| `--event` | `string` | no | | Full event names to filter by, comma-separated (payment.completed, pixel.lead, pixel.page, pixel.custom:<name>) — the same vocabulary the events / people metrics use. |
|
|
65
|
+
| `--source` | `string` | no | | Canonical source path, exact or with a trailing :* prefix (whop:<campaign>:*, ext:meta:*, referrer:<domain>, direct). Restricts the list to conversion targets attributed to that source — the debuggability twin of a metric cell's source parameter. |
|
|
66
|
+
| `--attribution_model` | `string` | no | | Attribution model for the source filter (defaults to last_touch). |
|
|
67
|
+
| `--country` | `string` | no | | Country codes to filter by, comma-separated. |
|
|
68
|
+
| `--city` | `string` | no | | Cities to filter by, comma-separated. |
|
|
69
|
+
| `--device` | `string` | no | | Device families to filter by, comma-separated (e.g. iPhone, Mac). |
|
|
70
|
+
| `--browser` | `string` | no | | Browser families to filter by, comma-separated (e.g. Chrome, Mobile Safari). |
|
|
71
|
+
| `--os` | `string` | no | | Operating system families to filter by, comma-separated (e.g. iOS, Windows). |
|
|
72
|
+
| `--utm_source` | `string` | no | | utm_source values to filter by, comma-separated. |
|
|
73
|
+
| `--hostname` | `string` | no | | Page hostnames to filter by, comma-separated. |
|
|
74
|
+
| `--page` | `string` | no | | Page paths to filter by, comma-separated. |
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
# whop events pulse
|
|
79
|
+
|
|
80
|
+
Retrieve the pulse feed
|
|
81
|
+
|
|
82
|
+
## Options
|
|
83
|
+
|
|
84
|
+
| Flag | Type | Required | Default | Description |
|
|
85
|
+
|------|------|----------|---------|-------------|
|
|
86
|
+
| `--event` | `string` | no | | Filter to one or more types, comma separated — for example `withdrawal,card_spend`. These are the item's `type`, not its `event_name`: several types share the `ledger_line.created` event name. Omit for every type in the feed. Values outside the feed's own set are rejected. |
|
|
87
|
+
| `--first` | `number` | no | | The number of events to return. |
|
|
88
|
+
| `--after` | `string` | no | | A cursor for fetching events after a previous page. |
|
|
89
|
+
| `--before` | `string` | no | | A cursor for fetching events before a later page. |
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
# whop events validate_pixel
|
|
94
|
+
|
|
95
|
+
Validate Pixel
|
|
96
|
+
|
|
97
|
+
## Options
|
|
98
|
+
|
|
99
|
+
| Flag | Type | Required | Default | Description |
|
|
100
|
+
|------|------|----------|---------|-------------|
|
|
101
|
+
| `--account_id` | `string` | no | | Account to check. Defaults to the authenticated account. |
|
|
102
|
+
| `--url` | `string` | no | | A page to read for the pixel, e.g. an ad destination. Omit it to check the account from its events alone. |
|
|
103
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
104
|
+
|
|
105
|
+
> Confirm with the user before executing this destructive command.
|
|
@@ -9,12 +9,334 @@ An Export is an asynchronous CSV of one resource for one account — members, pa
|
|
|
9
9
|
|
|
10
10
|
Use the Exports API to start an export, poll it until `download_url` is set, and list the exports already requested for an account. Finished CSVs are retained for 30 days, after which the file is deleted and the export moves to `expired`.
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
# whop exports create
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
|---------|-------------|
|
|
16
|
-
| `whop exports list` | List Exports |
|
|
17
|
-
| `whop exports create` | Create Export |
|
|
18
|
-
| `whop exports get` | Retrieve Export |
|
|
14
|
+
Create Export
|
|
19
15
|
|
|
20
|
-
|
|
16
|
+
## Options
|
|
17
|
+
|
|
18
|
+
| Flag | Type | Required | Default | Description |
|
|
19
|
+
|------|------|----------|---------|-------------|
|
|
20
|
+
| `--account_id` | `string` | no | | The account to export from, prefixed `biz_`. Defaults to the credential's account. |
|
|
21
|
+
| `--columns` | `array` | no | | Column keys to include. Empty means all columns for the resource. |
|
|
22
|
+
| `--filters` | `object` | no | | Resource-specific filters. For native REST resources (`payouts`, `transfers`, `memberships`) these are the resource's own list query params; for dashboard tables they mirror the dashboard table filters.
|
|
23
|
+
|
|
24
|
+
<details>
|
|
25
|
+
<summary>Filters by resource (22)</summary>
|
|
26
|
+
|
|
27
|
+
<details>
|
|
28
|
+
<summary>ad_campaigns (4)</summary>
|
|
29
|
+
|
|
30
|
+
Mirrors the filtering query params of `GET /api/v1/ad_campaigns`.
|
|
31
|
+
|
|
32
|
+
- `created_after` `string` — Only return campaigns created after this timestamp.
|
|
33
|
+
- `created_before` `string` — Only return campaigns created before this timestamp.
|
|
34
|
+
- `query` `string` — Filter campaigns by a title or ID substring.
|
|
35
|
+
- `status` `string` — Only return campaigns with this status. One of `draft`, `active`, `paused`, `payment_failed`.
|
|
36
|
+
|
|
37
|
+
</details>
|
|
38
|
+
<details>
|
|
39
|
+
<summary>ad_groups (6)</summary>
|
|
40
|
+
|
|
41
|
+
Mirrors the filtering query params of `GET /api/v1/ad_groups`.
|
|
42
|
+
|
|
43
|
+
- `ad_campaign_id` `string` — Filter to ad groups in this campaign.
|
|
44
|
+
- `ad_campaign_ids` `string[]` — Filter to ad groups in these campaigns (max 100). Repeat the parameter for each id (ad_campaign_ids=a&ad_campaign_ids=b).
|
|
45
|
+
- `created_after` `string` — Only return ad groups created after this timestamp.
|
|
46
|
+
- `created_before` `string` — Only return ad groups created before this timestamp.
|
|
47
|
+
- `query` `string` — Filter ad groups by a title or ID substring.
|
|
48
|
+
- `status` `string` — Filter to ad groups with this status. One of `active`, `paused`, `rejected`, `duplicating`.
|
|
49
|
+
|
|
50
|
+
</details>
|
|
51
|
+
<details>
|
|
52
|
+
<summary>ads (8)</summary>
|
|
53
|
+
|
|
54
|
+
Mirrors the filtering query params of `GET /api/v1/ads`.
|
|
55
|
+
|
|
56
|
+
- `ad_campaign_id` `string` — Only return ads in this ad campaign.
|
|
57
|
+
- `ad_campaign_ids` `string[]` — Only return ads in these ad campaigns (max 100). Repeat the parameter for each id (ad_campaign_ids=a&ad_campaign_ids=b).
|
|
58
|
+
- `ad_group_id` `string` — Only return ads in this ad group.
|
|
59
|
+
- `ad_group_ids` `string[]` — Only return ads in these ad groups (max 100). Repeat the parameter for each id (ad_group_ids=a&ad_group_ids=b).
|
|
60
|
+
- `created_after` `string` — Only return ads created after this timestamp.
|
|
61
|
+
- `created_before` `string` — Only return ads created before this timestamp.
|
|
62
|
+
- `query` `string` — Filter ads by a title or ID substring.
|
|
63
|
+
- `status` `string` — Only return ads with this status. One of `active`, `paused`, `in_review`, `rejected`.
|
|
64
|
+
|
|
65
|
+
</details>
|
|
66
|
+
<details>
|
|
67
|
+
<summary>audiences (3)</summary>
|
|
68
|
+
|
|
69
|
+
Mirrors the filtering query params of `GET /api/v1/audiences`.
|
|
70
|
+
|
|
71
|
+
- `audience_id` `string` — Audience ID, prefixed `adaud_`, used to filter the response to one audience.
|
|
72
|
+
- `audience_type` `string` — Filter by audience type: `custom` (uploaded lists) or `lookalike`. One of `custom`, `lookalike`.
|
|
73
|
+
- `source_type` `string` — Filter by member source: `csv_upload` (uploaded lists) or `people_filter` (automatic audiences built from saved People filters). One of `csv_upload`, `people_filter`.
|
|
74
|
+
|
|
75
|
+
</details>
|
|
76
|
+
<details>
|
|
77
|
+
<summary>bounties (5)</summary>
|
|
78
|
+
|
|
79
|
+
Mirrors the filtering query params of `GET /api/v1/bounties`.
|
|
80
|
+
|
|
81
|
+
- `created_after` `string` — Only bounties created after this ISO 8601 timestamp.
|
|
82
|
+
- `created_before` `string` — Only bounties created before this ISO 8601 timestamp.
|
|
83
|
+
- `query` `string` — Substring match on the bounty title or ID.
|
|
84
|
+
- `status` `string` — Filter by lifecycle state. One of `scheduled`, `open`, `closed`, `completed`, `canceled`.
|
|
85
|
+
- `user_id` `string` — List the bounties this user participated in (`user_` tag). Must be the authenticated user.
|
|
86
|
+
|
|
87
|
+
</details>
|
|
88
|
+
<details>
|
|
89
|
+
<summary>bounty_submissions (4)</summary>
|
|
90
|
+
|
|
91
|
+
Mirrors the filtering query params of `GET /api/v1/bounty_submissions`.
|
|
92
|
+
|
|
93
|
+
- `bounty_id` `string` — Only submissions on this bounty (`bnty_` tag).
|
|
94
|
+
- `created_after` `string` — Only submissions created after this ISO 8601 timestamp.
|
|
95
|
+
- `created_before` `string` — Only submissions created before this ISO 8601 timestamp.
|
|
96
|
+
- `status` `string` — Filter by lifecycle state. One of `in_progress`, `submitted`, `approved`, `denied`.
|
|
97
|
+
|
|
98
|
+
</details>
|
|
99
|
+
<details>
|
|
100
|
+
<summary>disputes (4)</summary>
|
|
101
|
+
|
|
102
|
+
Mirrors the filtering query params of `GET /api/v1/disputes`.
|
|
103
|
+
|
|
104
|
+
- `created_after` `string` — Only disputes opened after this ISO 8601 timestamp.
|
|
105
|
+
- `created_before` `string` — Only disputes opened before this ISO 8601 timestamp.
|
|
106
|
+
- `currency` `string` — Only disputes in this three-letter ISO currency.
|
|
107
|
+
- `status` `string[]` — Only disputes in these statuses. Repeat the parameter to pass several — one paginated list covers all of them. Covers both chargebacks and inquiries at each stage.
|
|
108
|
+
|
|
109
|
+
</details>
|
|
110
|
+
<details>
|
|
111
|
+
<summary>events (14)</summary>
|
|
112
|
+
|
|
113
|
+
Mirrors the filtering query params of `GET /api/v1/events`.
|
|
114
|
+
|
|
115
|
+
- `attribution_model` `string` — Attribution model for the source filter (defaults to last_touch). One of `last_touch`, `first_touch`.
|
|
116
|
+
- `browser` `string` — Browser families to filter by, comma-separated (e.g. Chrome, Mobile Safari).
|
|
117
|
+
- `city` `string` — Cities to filter by, comma-separated.
|
|
118
|
+
- `country` `string` — Country codes to filter by, comma-separated.
|
|
119
|
+
- `device` `string` — Device families to filter by, comma-separated (e.g. iPhone, Mac).
|
|
120
|
+
- `event` `string` — Full event names to filter by, comma-separated (payment.completed, pixel.lead, pixel.page, pixel.custom:<name>) — the same vocabulary the events / people metrics use.
|
|
121
|
+
- `from` `string` — Start of the time range as an ISO 8601 timestamp. Required when identifier is omitted.
|
|
122
|
+
- `hostname` `string` — Page hostnames to filter by, comma-separated.
|
|
123
|
+
- `identifier` `string` — Any hard identifier of the person: a person ID (prsn_*), user ID, email, phone number, or a tracking cookie value (wuid, anonymous ID, fbp/fbc/ttp/ga). Omit to list recent events for the account.
|
|
124
|
+
- `os` `string` — Operating system families to filter by, comma-separated (e.g. iOS, Windows).
|
|
125
|
+
- `page` `string` — Page paths to filter by, comma-separated.
|
|
126
|
+
- `source` `string` — Canonical source path, exact or with a trailing :* prefix (whop:<campaign>:*, ext:meta:*, referrer:<domain>, direct). Restricts the list to conversion targets attributed to that source — the debuggability twin of a metric cell's source parameter.
|
|
127
|
+
- `to` `string` — End of the time range as an ISO 8601 timestamp. Required when identifier is omitted; otherwise defaults to now.
|
|
128
|
+
- `utm_source` `string` — utm_source values to filter by, comma-separated.
|
|
129
|
+
|
|
130
|
+
</details>
|
|
131
|
+
<details>
|
|
132
|
+
<summary>financial-activity (8)</summary>
|
|
133
|
+
|
|
134
|
+
Mirrors the filtering query params of `GET /api/v1/financial-activity`.
|
|
135
|
+
|
|
136
|
+
- `available_after` `string` — Only include rows whose funds became withdrawable on or after this `YYYY-MM-DD` settlement date (UTC), distinct from posted_at. Requires currency.
|
|
137
|
+
- `available_before` `string` — Only include rows whose funds became withdrawable on or before this `YYYY-MM-DD` settlement date (UTC). Set equal to available_after for a single day. Requires currency.
|
|
138
|
+
- `currency` `string` — Optional currency code filter, for example `usd`.
|
|
139
|
+
- `include_owned_accounts` `boolean` — When true, aggregates the authenticated user's personal ledger with the businesses they own (owner role with balance read) into one feed. Requires user_id to be the authenticated user; cannot be combined with account_id or the settlement-date filters. Each returned row includes the owning `account`.
|
|
140
|
+
- `line_types` `string[]` — Optional ledger line categories to include. Some categories (for example `onchain_deposit`, which covers inbound crypto deposits such as MoonPay onramps) are only returned when explicitly requested here.
|
|
141
|
+
- `posted_after` `string` — Only include rows posted after this ISO 8601 timestamp.
|
|
142
|
+
- `posted_before` `string` — Only include rows posted before this ISO 8601 timestamp.
|
|
143
|
+
- `user_id` `string` — The owning user ID (a user_ identifier). Provide this or account_id.
|
|
144
|
+
|
|
145
|
+
</details>
|
|
146
|
+
<details>
|
|
147
|
+
<summary>members (5)</summary>
|
|
148
|
+
|
|
149
|
+
Mirrors the filtering query params of `GET /api/v1/members`.
|
|
150
|
+
|
|
151
|
+
- `access_level` `string` — Filter by what the member can reach on the account. One of `no_access`, `admin`, `customer`.
|
|
152
|
+
- `created_after` `string` — Only members who joined after this ISO 8601 timestamp.
|
|
153
|
+
- `created_before` `string` — Only members who joined before this ISO 8601 timestamp.
|
|
154
|
+
- `query` `string` — Search members by name or username. An exact email address also matches when the credential holds the member:email:read scope.
|
|
155
|
+
- `status` `string` — Filter by whether the member is still part of the account. One of `joined`, `left`.
|
|
156
|
+
|
|
157
|
+
</details>
|
|
158
|
+
<details>
|
|
159
|
+
<summary>memberships (6)</summary>
|
|
160
|
+
|
|
161
|
+
Mirrors the filtering query params of `GET /api/v1/memberships`.
|
|
162
|
+
|
|
163
|
+
- `created_after` `string` — Only memberships created after this ISO 8601 timestamp.
|
|
164
|
+
- `created_before` `string` — Only memberships created before this ISO 8601 timestamp.
|
|
165
|
+
- `plan_id` `string` — Filter to memberships of this plan (`plan_` tag). Repeat as plan_ids[] for several.
|
|
166
|
+
- `product_id` `string` — Filter to memberships of this product (`prod_` tag). Repeat as product_ids[] for several.
|
|
167
|
+
- `status` `string` — Filter by billing state. `canceling` matches active memberships set to cancel at period end; `paused` matches memberships with payment collection paused. One of `active`, `trialing`, `past_due`, `completed`, `canceled`, `expired`, `canceling`, `paused`.
|
|
168
|
+
- `user_id` `string` — Narrow to one user's memberships (`user_` tag, or `me` for the caller). A user outside the caller's visible set returns an empty list.
|
|
169
|
+
|
|
170
|
+
</details>
|
|
171
|
+
<details>
|
|
172
|
+
<summary>payouts (2)</summary>
|
|
173
|
+
|
|
174
|
+
Mirrors the filtering query params of `GET /api/v1/payouts`.
|
|
175
|
+
|
|
176
|
+
- `currency` `string` — Optional currency code filter, for example `usd`.
|
|
177
|
+
- `user_id` `string` — The owning user ID (a user_ identifier). Provide this or account_id.
|
|
178
|
+
|
|
179
|
+
</details>
|
|
180
|
+
<details>
|
|
181
|
+
<summary>people (20)</summary>
|
|
182
|
+
|
|
183
|
+
Mirrors the filtering query params of `GET /api/v1/people`.
|
|
184
|
+
|
|
185
|
+
- `attribution_model` `string` — Attribution model the source filter matches against (defaults to last_touch). One of `last_touch`, `first_touch`.
|
|
186
|
+
- `audience_id` `string` — Only include people in this audience. An audience that keeps itself up to date resolves to the People filters that define it, so this always reflects who matches now; uploaded lists and point-in-time snapshots match their recorded members.
|
|
187
|
+
- `contactable` `boolean` — true for people who have an email address or phone number — the ones an ad platform can match.
|
|
188
|
+
- `country` `string` — Only include people whose most recent visit came from this ISO 3166-1 alpha-2 country code.
|
|
189
|
+
- `custom_event` `string` — Only include people who fired this custom pixel event.
|
|
190
|
+
- `email` `string` — Only include the person linked to this email address.
|
|
191
|
+
- `event_from` `string` — With event_to plus an event or source filter, switches to exact-population mode: person ids are resolved and paginated on the events side within this window (the same query the people metric counts), then hydrated per page.
|
|
192
|
+
- `event_name` `string[]` — Only include people who fired any of these events, e.g. payment.completed or page.checkout.view.
|
|
193
|
+
- `event_to` `string` — The inclusive end of the event window for exact-population mode.
|
|
194
|
+
- `first_seen_after` `string` — Only include people first seen at or after this ISO 8601 timestamp.
|
|
195
|
+
- `first_seen_before` `string` — Only include people first seen before this ISO 8601 timestamp.
|
|
196
|
+
- `first_seen_within_days` `integer` — Only include people first seen within this many days, as a rolling window.
|
|
197
|
+
- `has_purchased` `boolean` — true for customers only, false for people who have never purchased.
|
|
198
|
+
- `last_seen_after` `string` — Only include people last seen at or after this ISO 8601 timestamp.
|
|
199
|
+
- `last_seen_before` `string` — Only include people last seen before this ISO 8601 timestamp.
|
|
200
|
+
- `last_seen_within_days` `integer` — Only include people last seen within this many days, as a rolling window.
|
|
201
|
+
- `phone` `string` — Only include the person linked to this phone number.
|
|
202
|
+
- `query` `string` — Search people by name, email, phone, or whop user ID (case-insensitive substring match).
|
|
203
|
+
- `source` `string[]` — Only include people acquired from any of these sources — canonical paths (whop:<campaign>:<group>:<ad>, ext:<platform>:..., referrer:<domain>, direct, other), exact or with a trailing :* prefix. The same vocabulary the events / people metrics use.
|
|
204
|
+
- `user_id` `string` — Only include the person linked to this whop user ID.
|
|
205
|
+
|
|
206
|
+
</details>
|
|
207
|
+
<details>
|
|
208
|
+
<summary>plans (6)</summary>
|
|
209
|
+
|
|
210
|
+
Mirrors the filtering query params of `GET /api/v1/plans`.
|
|
211
|
+
|
|
212
|
+
- `created_after` `string` — Only return plans created after this timestamp.
|
|
213
|
+
- `created_before` `string` — Only return plans created before this timestamp.
|
|
214
|
+
- `plan_types` `string[]` — Filter to only plans matching these billing types.
|
|
215
|
+
- `product_ids` `string[]` — Filter to only plans belonging to these product identifiers.
|
|
216
|
+
- `release_methods` `string[]` — Filter to only plans matching these release methods.
|
|
217
|
+
- `visibilities` `string[]` — Filter to only plans matching these visibility states.
|
|
218
|
+
|
|
219
|
+
</details>
|
|
220
|
+
<details>
|
|
221
|
+
<summary>products (2)</summary>
|
|
222
|
+
|
|
223
|
+
Mirrors the filtering query params of `GET /api/v1/products`.
|
|
224
|
+
|
|
225
|
+
- `access_pass_types` `string[]` — Filter to only products matching these types.
|
|
226
|
+
- `visibilities` `string[]` — Filter to only products matching these visibility states.
|
|
227
|
+
|
|
228
|
+
</details>
|
|
229
|
+
<details>
|
|
230
|
+
<summary>promo_codes (5)</summary>
|
|
231
|
+
|
|
232
|
+
Mirrors the filtering query params of `GET /api/v1/promo_codes`.
|
|
233
|
+
|
|
234
|
+
- `created_after` `string` — Only promo codes created after this ISO 8601 timestamp.
|
|
235
|
+
- `created_before` `string` — Only promo codes created before this ISO 8601 timestamp.
|
|
236
|
+
- `plan_ids` `string[]` — Only promo codes scoped to these plan IDs.
|
|
237
|
+
- `product_ids` `string[]` — Only promo codes scoped to these product IDs.
|
|
238
|
+
- `status` `string` — Promo-code status. `expired` groups inactive and archived codes. One of `active`, `inactive`, `archived`, `expired`.
|
|
239
|
+
|
|
240
|
+
</details>
|
|
241
|
+
<details>
|
|
242
|
+
<summary>resolution_center_cases (6)</summary>
|
|
243
|
+
|
|
244
|
+
Mirrors the filtering query params of `GET /api/v1/resolution_center_cases`.
|
|
245
|
+
|
|
246
|
+
- `created_after` `string` — Only cases created after this ISO 8601 timestamp.
|
|
247
|
+
- `created_before` `string` — Only cases created before this ISO 8601 timestamp.
|
|
248
|
+
- `outcome` `string[]` — Only closed cases that ended these ways. Repeat the parameter to pass several.
|
|
249
|
+
- `reason` `string[]` — Only cases opened for these reasons. Repeat the parameter to pass several.
|
|
250
|
+
- `status` `string[]` — Only cases in these statuses. Repeat the parameter to pass several — one paginated list covers all of them.
|
|
251
|
+
- `user_id` `string` — Only cases opened by this customer — a `user_` tag, or `me` for the calling user. It narrows what you can already read, so `me` lists the cases you opened without the ones on accounts you are a team member of.
|
|
252
|
+
|
|
253
|
+
</details>
|
|
254
|
+
<details>
|
|
255
|
+
<summary>shipments (4)</summary>
|
|
256
|
+
|
|
257
|
+
Mirrors the filtering query params of `GET /api/v1/shipments`.
|
|
258
|
+
|
|
259
|
+
- `created_after` `string` — Return shipments created after this ISO 8601 timestamp.
|
|
260
|
+
- `created_before` `string` — Return shipments created before this ISO 8601 timestamp.
|
|
261
|
+
- `payment_id` `string[]` — Only shipments fulfilling these payments, each prefixed `pay_`. Repeat the parameter to pass several, up to 100 per request — one paginated list covers all of them.
|
|
262
|
+
- `status` `string` — Filter to shipments with this delivery status. One of `unknown`, `pre_transit`, `in_transit`, `out_for_delivery`, `delivered`, `available_for_pickup`, `return_to_sender`, `failure`, `cancelled`, `error`.
|
|
263
|
+
|
|
264
|
+
</details>
|
|
265
|
+
<details>
|
|
266
|
+
<summary>social_accounts (4)</summary>
|
|
267
|
+
|
|
268
|
+
Mirrors the filtering query params of `GET /api/v1/social_accounts`.
|
|
269
|
+
|
|
270
|
+
- `platform` `string` — Only return social accounts for the platform that is specified. One of `x`, `instagram`, `youtube`, `tiktok`, `facebook`, `discord`, `telegram`.
|
|
271
|
+
- `scopes` `string[]` — Only return social accounts that have these scopes.
|
|
272
|
+
- `user_id` `string` — The User that the social accounts are connected to. Provide either this or account_id.
|
|
273
|
+
- `verified` `boolean` — Only return social accounts that are verified on the platform.
|
|
274
|
+
|
|
275
|
+
</details>
|
|
276
|
+
<details>
|
|
277
|
+
<summary>team_members (5)</summary>
|
|
278
|
+
|
|
279
|
+
Mirrors the filtering query params of `GET /api/v1/team_members`.
|
|
280
|
+
|
|
281
|
+
- `created_after` `string` — Only return members added after this ISO 8601 timestamp.
|
|
282
|
+
- `created_before` `string` — Only return members added before this ISO 8601 timestamp.
|
|
283
|
+
- `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`.
|
|
284
|
+
- `status` `string` — Only return members with this status: `joined` (accepted members) or `pending` (pending invites). Both are returned by default. One of `joined`, `pending`.
|
|
285
|
+
- `user_id` `string` — Only return the membership for this user ID, prefixed `user_`.
|
|
286
|
+
|
|
287
|
+
</details>
|
|
288
|
+
<details>
|
|
289
|
+
<summary>transfers (4)</summary>
|
|
290
|
+
|
|
291
|
+
Mirrors the filtering query params of `GET /api/v1/transfers`.
|
|
292
|
+
|
|
293
|
+
- `created_after` `string` — Only transfers created strictly after this ISO 8601 timestamp.
|
|
294
|
+
- `created_before` `string` — Only transfers created strictly before this ISO 8601 timestamp.
|
|
295
|
+
- `destination_id` `string` — Filter to transfers received by this account. Provide this or origin_id.
|
|
296
|
+
- `origin_id` `string` — Filter to transfers sent from this account. Provide this or destination_id.
|
|
297
|
+
|
|
298
|
+
</details>
|
|
299
|
+
<details>
|
|
300
|
+
<summary>webhooks (1)</summary>
|
|
301
|
+
|
|
302
|
+
Mirrors the filtering query params of `GET /api/v1/webhooks`.
|
|
303
|
+
|
|
304
|
+
- `app_id` `string` — Only return webhooks attached to this app. Omit to list the account's own webhooks.
|
|
305
|
+
|
|
306
|
+
</details>
|
|
307
|
+
</details> |
|
|
308
|
+
| `--resource` | `string` | yes | | The resource to export, e.g. `payouts`, `receipts`, or `members`. |
|
|
309
|
+
| `--timezone` | `string` | no | | IANA timezone for date columns, e.g. `America/New_York`. Defaults to `UTC`. |
|
|
310
|
+
| `--idempotency-key` | `string` | no | | A unique key that makes this request safe to retry. See [Idempotent requests](https://docs.whop.com/developer/api/idempotency). |
|
|
311
|
+
|
|
312
|
+
> Confirm with the user before executing this destructive command.
|
|
313
|
+
|
|
314
|
+
---
|
|
315
|
+
|
|
316
|
+
# whop exports get
|
|
317
|
+
|
|
318
|
+
Retrieve Export
|
|
319
|
+
|
|
320
|
+
## Arguments
|
|
321
|
+
|
|
322
|
+
| Name | Type | Required | Description |
|
|
323
|
+
|------|------|----------|-------------|
|
|
324
|
+
| `id` | `string` | yes | The export ID, prefixed `exprt_`. |
|
|
325
|
+
|
|
326
|
+
---
|
|
327
|
+
|
|
328
|
+
# whop exports list
|
|
329
|
+
|
|
330
|
+
List Exports
|
|
331
|
+
|
|
332
|
+
## Options
|
|
333
|
+
|
|
334
|
+
| Flag | Type | Required | Default | Description |
|
|
335
|
+
|------|------|----------|---------|-------------|
|
|
336
|
+
| `--account_id` | `string` | no | | The account to list exports for, prefixed `biz_`. Defaults to the credential's account. |
|
|
337
|
+
| `--resource` | `string` | no | | Only return exports of this resource. |
|
|
338
|
+
| `--status` | `string` | no | | Only return exports in this status. |
|
|
339
|
+
| `--created_after` | `string` | no | | Only return exports created at or after this ISO 8601 timestamp. |
|
|
340
|
+
| `--created_before` | `string` | no | | Only return exports created at or before this ISO 8601 timestamp. |
|
|
341
|
+
| `--order` | `string` | no | | The field to sort by. |
|
|
342
|
+
| `--direction` | `string` | no | | The sort direction. |
|