@whop/cli 0.16.0 → 0.16.1
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 +1534 -412
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
- 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,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. |
|
|
@@ -1,99 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: whop-disputes
|
|
3
|
-
description: Chargebacks filed against an account, with evidence and outcomes. Run `whop disputes --help` for usage details.
|
|
4
|
-
requires_bin: whop
|
|
5
|
-
command: whop disputes
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
A Dispute is a chargeback a customer files against a payment through their bank, or an inquiry that may become one. It carries the disputed payment, a deadline to respond, your evidence, and the outcome once the processor rules.
|
|
9
|
-
|
|
10
|
-
Use the Disputes API to list disputes, edit the evidence packet while a dispute is still contestable, and submit it for review.
|
|
11
|
-
|
|
12
|
-
# whop disputes get
|
|
13
|
-
|
|
14
|
-
Retrieve Dispute
|
|
15
|
-
|
|
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.
|
|
@@ -1,105 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: whop-events
|
|
3
|
-
description: Conversion and engagement events tracked for attribution. Run `whop events --help` for usage details.
|
|
4
|
-
requires_bin: whop
|
|
5
|
-
command: whop events
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
An Event records conversion or engagement activity for an account, such as page views, purchases, or leads. Each event ties the action to the [person](https://docs.whop.com/api-reference/beta/people/person) who took it, so activity can be attributed to the ads and links that drove it.
|
|
9
|
-
|
|
10
|
-
Use the Events API to send new tracking events, list recent identity-linked events for an account, and inspect the events recorded for a person. The resource also exposes an anonymized read mode — the pulse feed — a platform-wide snapshot of recent purchases that carries nothing identifying. The pulse feed is public; other Events endpoints require authentication and are scoped to an account.
|
|
11
|
-
|
|
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
|
-
|
|
14
|
-
# whop events create
|
|
15
|
-
|
|
16
|
-
Create Event
|
|
17
|
-
|
|
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 `purchase,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.
|