@kelviq/mcp-server 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +322 -0
- package/dist/config.d.ts +16 -0
- package/dist/config.js +45 -0
- package/dist/config.js.map +1 -0
- package/dist/docs/README.md +128 -0
- package/dist/docs/api-reference/authentication.md +41 -0
- package/dist/docs/backend-integration/node-sdk.md +1040 -0
- package/dist/docs/backend-integration/python-sdk.md +1198 -0
- package/dist/docs/changelog/app.md +80 -0
- package/dist/docs/changelog/checkout-api.md +59 -0
- package/dist/docs/changelog/js-promotions-ui.md +14 -0
- package/dist/docs/changelog/js-sdk.md +281 -0
- package/dist/docs/changelog/node-sdk.md +378 -0
- package/dist/docs/changelog/python-sdk.md +456 -0
- package/dist/docs/changelog/react-sdk.md +580 -0
- package/dist/docs/checkout/checkout-configuration.md +434 -0
- package/dist/docs/coustomers-management/overview.md +111 -0
- package/dist/docs/customer-portal/overview.md +81 -0
- package/dist/docs/frontend-integration/js-sdk.md +676 -0
- package/dist/docs/frontend-integration/promotions-ui-js.md +265 -0
- package/dist/docs/frontend-integration/react-promotions-ui.md +361 -0
- package/dist/docs/frontend-integration/react-sdk.md +1187 -0
- package/dist/docs/frontend-integration/react-ui.md +771 -0
- package/dist/docs/getstarted/fees.md +160 -0
- package/dist/docs/getstarted/introduction-to-kelviq.md +80 -0
- package/dist/docs/getstarted/merchant-of-record.md +64 -0
- package/dist/docs/getstarted/review-process.md +190 -0
- package/dist/docs/guides/subscription-integration-for-nextjs.md +512 -0
- package/dist/docs/guides/subscription-integration.md +291 -0
- package/dist/docs/guides/webhooks.md +963 -0
- package/dist/docs/legal/approved-prohibited-policy.md +252 -0
- package/dist/docs/legal/buyer-terms.md +177 -0
- package/dist/docs/legal/compliant-user-flow.md +216 -0
- package/dist/docs/legal/master-service-agreement.md +404 -0
- package/dist/docs/legal/payment-flow-diagram.md +188 -0
- package/dist/docs/legal/seller-terms.md +169 -0
- package/dist/docs/manifest.json +415 -0
- package/dist/docs/monetization/offerings.md +156 -0
- package/dist/docs/monetization/pricing-tables.md +226 -0
- package/dist/docs/monetization/targeting-rules.md +278 -0
- package/dist/docs/openapi.json +5479 -0
- package/dist/docs/payouts/overview.md +43 -0
- package/dist/docs/payouts/payout-account.md +12 -0
- package/dist/docs/payouts/transactions.md +23 -0
- package/dist/docs/product-catalog/digital-downloads.md +117 -0
- package/dist/docs/product-catalog/discounts.md +69 -0
- package/dist/docs/product-catalog/entitlements.md +428 -0
- package/dist/docs/product-catalog/free-and-trials.md +36 -0
- package/dist/docs/product-catalog/license-keys.md +324 -0
- package/dist/docs/product-catalog/links.md +92 -0
- package/dist/docs/product-catalog/location-based-pricing.md +41 -0
- package/dist/docs/product-catalog/one-time-payments.md +24 -0
- package/dist/docs/product-catalog/plans.md +199 -0
- package/dist/docs/product-catalog/products.md +60 -0
- package/dist/docs/product-catalog/subscriptions.md +29 -0
- package/dist/docs/product-catalog/tax-settings.md +37 -0
- package/dist/docs/product-catalog/usage-based-billing.md +119 -0
- package/dist/docs/promotions/create-a-promotion.md +75 -0
- package/dist/docs/promotions/customize-banner.md +41 -0
- package/dist/docs/promotions/integrate.md +38 -0
- package/dist/docs/promotions/overview.md +51 -0
- package/dist/docs/quickstart/core-concepts.md +146 -0
- package/dist/docs/quickstart/dashboard-setup.md +129 -0
- package/dist/docs/quickstart/integrate-with-your-app.md +149 -0
- package/dist/docs/sales/checkout-sessions.md +58 -0
- package/dist/docs/sales/orders.md +76 -0
- package/dist/http/client.d.ts +28 -0
- package/dist/http/client.js +76 -0
- package/dist/http/client.js.map +1 -0
- package/dist/http/errors.d.ts +20 -0
- package/dist/http/errors.js +58 -0
- package/dist/http/errors.js.map +1 -0
- package/dist/resources/docs-index.d.ts +25 -0
- package/dist/resources/docs-index.js +109 -0
- package/dist/resources/docs-index.js.map +1 -0
- package/dist/resources/index.d.ts +2 -0
- package/dist/resources/index.js +73 -0
- package/dist/resources/index.js.map +1 -0
- package/dist/schemas/kelviq.d.ts +1304 -0
- package/dist/schemas/kelviq.js +468 -0
- package/dist/schemas/kelviq.js.map +1 -0
- package/dist/server.d.ts +2 -0
- package/dist/server.js +41 -0
- package/dist/server.js.map +1 -0
- package/dist/tools/_util.d.ts +15 -0
- package/dist/tools/_util.js +15 -0
- package/dist/tools/_util.js.map +1 -0
- package/dist/tools/checkout.d.ts +3 -0
- package/dist/tools/checkout.js +18 -0
- package/dist/tools/checkout.js.map +1 -0
- package/dist/tools/customers.d.ts +3 -0
- package/dist/tools/customers.js +32 -0
- package/dist/tools/customers.js.map +1 -0
- package/dist/tools/docs.d.ts +2 -0
- package/dist/tools/docs.js +43 -0
- package/dist/tools/docs.js.map +1 -0
- package/dist/tools/entitlements.d.ts +3 -0
- package/dist/tools/entitlements.js +22 -0
- package/dist/tools/entitlements.js.map +1 -0
- package/dist/tools/features.d.ts +3 -0
- package/dist/tools/features.js +55 -0
- package/dist/tools/features.js.map +1 -0
- package/dist/tools/index.d.ts +3 -0
- package/dist/tools/index.js +44 -0
- package/dist/tools/index.js.map +1 -0
- package/dist/tools/licenses.d.ts +3 -0
- package/dist/tools/licenses.js +44 -0
- package/dist/tools/licenses.js.map +1 -0
- package/dist/tools/media.d.ts +3 -0
- package/dist/tools/media.js +18 -0
- package/dist/tools/media.js.map +1 -0
- package/dist/tools/offerings.d.ts +3 -0
- package/dist/tools/offerings.js +21 -0
- package/dist/tools/offerings.js.map +1 -0
- package/dist/tools/partner.d.ts +3 -0
- package/dist/tools/partner.js +55 -0
- package/dist/tools/partner.js.map +1 -0
- package/dist/tools/plan-entitlements.d.ts +3 -0
- package/dist/tools/plan-entitlements.js +56 -0
- package/dist/tools/plan-entitlements.js.map +1 -0
- package/dist/tools/plan-files.d.ts +3 -0
- package/dist/tools/plan-files.js +43 -0
- package/dist/tools/plan-files.js.map +1 -0
- package/dist/tools/plans.d.ts +3 -0
- package/dist/tools/plans.js +120 -0
- package/dist/tools/plans.js.map +1 -0
- package/dist/tools/portal.d.ts +3 -0
- package/dist/tools/portal.js +18 -0
- package/dist/tools/portal.js.map +1 -0
- package/dist/tools/product-files.d.ts +3 -0
- package/dist/tools/product-files.js +31 -0
- package/dist/tools/product-files.js.map +1 -0
- package/dist/tools/product-settings.d.ts +3 -0
- package/dist/tools/product-settings.js +31 -0
- package/dist/tools/product-settings.js.map +1 -0
- package/dist/tools/products.d.ts +3 -0
- package/dist/tools/products.js +69 -0
- package/dist/tools/products.js.map +1 -0
- package/dist/tools/promotions.d.ts +3 -0
- package/dist/tools/promotions.js +19 -0
- package/dist/tools/promotions.js.map +1 -0
- package/dist/tools/subscriptions.d.ts +3 -0
- package/dist/tools/subscriptions.js +63 -0
- package/dist/tools/subscriptions.js.map +1 -0
- package/dist/tools/usage.d.ts +3 -0
- package/dist/tools/usage.js +18 -0
- package/dist/tools/usage.js.map +1 -0
- package/package.json +88 -0
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Free plans and trials"
|
|
3
|
+
slug: "product-catalog/free-and-trials"
|
|
4
|
+
section: "product-catalog"
|
|
5
|
+
description: "Set up lead magnets and trial periods"
|
|
6
|
+
---
|
|
7
|
+
You do not always need to charge upfront. Kelviq lets you offer completely free plans or time restricted trials to help acquire users.
|
|
8
|
+
|
|
9
|
+
<img height="200" src="/images/configure-price.png" />
|
|
10
|
+
|
|
11
|
+
## Free plans
|
|
12
|
+
|
|
13
|
+
Use a free plan to offer a permanent zero cost tier. This is perfect for open source products, lead magnets, or a basic hobby tier where you want to gather signups without requiring a credit card.
|
|
14
|
+
|
|
15
|
+
<img height="200" src="/images/free-paid.png" />
|
|
16
|
+
|
|
17
|
+
1. Open your draft plan
|
|
18
|
+
2. Toggle the switch in the top right from Paid to Free
|
|
19
|
+
3. Save your changes
|
|
20
|
+
|
|
21
|
+
Users who select this plan bypass the payment step entirely. They still get access to the customer portal and any deliverables or entitlements attached to the plan.
|
|
22
|
+
|
|
23
|
+
## Free trials
|
|
24
|
+
|
|
25
|
+
Free trials let customers test a paid plan for a specific number of days before their card is charged.
|
|
26
|
+
|
|
27
|
+
<img height="200" src="/images/billing-cycle.png" />
|
|
28
|
+
|
|
29
|
+
1. Open a paid plan draft
|
|
30
|
+
2. Select your billing cycles like monthly or yearly
|
|
31
|
+
3. Enable the Free trial toggle
|
|
32
|
+
4. Enter the number of days the trial should last
|
|
33
|
+
|
|
34
|
+
When a customer signs up they must enter a valid payment method. We authorize the card but do not charge it. When the trial period ends Kelviq automatically charges the card and begins the regular billing cycle.
|
|
35
|
+
|
|
36
|
+
If the user cancels before the trial ends they are not charged.
|
|
@@ -0,0 +1,324 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "License Key Management"
|
|
3
|
+
slug: "product-catalog/license-keys"
|
|
4
|
+
section: "product-catalog"
|
|
5
|
+
description: "Generate and manage license keys for your products"
|
|
6
|
+
---
|
|
7
|
+
License keys allow you to generate unique activation keys for each customer purchase. This guide covers how to enable and configure licenses on your plans, manage them from orders, and how your customers can activate and validate licenses using the API.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
<img height="200" src="/images/accessing-key.png" />
|
|
12
|
+
|
|
13
|
+
## 1. Enabling Licenses on a Plan
|
|
14
|
+
|
|
15
|
+
License keys are configured at the **plan level**. When enabled, every order placed for that plan will automatically generate a unique license key for the customer.
|
|
16
|
+
### How to Enable Licenses
|
|
17
|
+
|
|
18
|
+
<img height="200" src="/images/enable-key.png" />
|
|
19
|
+
|
|
20
|
+
1. Navigate to **Products** → Select your product → Select the plan you want to configure
|
|
21
|
+
2. Scroll down to the **License keys** section
|
|
22
|
+
3. Toggle the switch to **enable** license keys
|
|
23
|
+
|
|
24
|
+
### Configuration Options
|
|
25
|
+
|
|
26
|
+
Once enabled, you can configure the following settings:
|
|
27
|
+
|
|
28
|
+
#### Activation Limit
|
|
29
|
+
|
|
30
|
+
Control how many times a single license key can be activated across different devices.
|
|
31
|
+
|
|
32
|
+
<img height="200" src="/images/set-limit.png" />
|
|
33
|
+
|
|
34
|
+
| Setting | Description |
|
|
35
|
+
|---------|-------------|
|
|
36
|
+
| **Enabled** | Limit activations to a specific number (e.g., 5 devices) |
|
|
37
|
+
| **Disabled** | Unlimited activations allowed |
|
|
38
|
+
|
|
39
|
+
> **Use case**: Set a limit of 3 if you want customers to use the license on up to 3 computers.
|
|
40
|
+
|
|
41
|
+
#### License Expiry
|
|
42
|
+
|
|
43
|
+
Define how long the license key remains valid after purchase.
|
|
44
|
+
|
|
45
|
+
<img height="200" src="/images/set-duration.png" />
|
|
46
|
+
|
|
47
|
+
| Setting | Description |
|
|
48
|
+
|---------|-------------|
|
|
49
|
+
| **Enabled** | License expires after a specified duration |
|
|
50
|
+
| **Disabled** | License never expires |
|
|
51
|
+
|
|
52
|
+
When expiry is enabled, you can set:
|
|
53
|
+
- **Duration value**: A number (e.g., 1, 6, 12)
|
|
54
|
+
- **Duration unit**: Days, Months, or Years
|
|
55
|
+
|
|
56
|
+
> **Example**: Setting duration to `12 Months` means the license expires 12 months after the purchase date.
|
|
57
|
+
|
|
58
|
+
### Save Your Configuration
|
|
59
|
+
|
|
60
|
+
After configuring the settings, click **Save Changes**. All future orders for this plan will use these license settings.
|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## 2. Managing Licenses from Order Details
|
|
65
|
+
|
|
66
|
+
Once a customer places an order for a plan with licenses enabled, you can manage their license from the **Order Details** page.
|
|
67
|
+
|
|
68
|
+
### Viewing License Information
|
|
69
|
+
|
|
70
|
+
Navigate to **Orders** → Click on an order to view details. The license section displays:
|
|
71
|
+
|
|
72
|
+
<img height="200" src="/images/managing-licenses-from-order-details.png" />
|
|
73
|
+
|
|
74
|
+
- **License Key**: The unique key assigned to this order
|
|
75
|
+
- **Expiry Date**: When the license expires (or "Never expires")
|
|
76
|
+
- **Activation Status**: Active count vs. limit (e.g., "2/5 activations" or "3/Unlimited")
|
|
77
|
+
- **License Status**: Active or Deactivated
|
|
78
|
+
|
|
79
|
+
### Available Actions
|
|
80
|
+
|
|
81
|
+
Click the **⋮** menu button on the license card to access these options:
|
|
82
|
+
|
|
83
|
+
<img height="200" src="/images/available-actions.png" />
|
|
84
|
+
|
|
85
|
+
#### 🔄 Regenerate Key
|
|
86
|
+
|
|
87
|
+
<img height="200" src="/images/regenerat-key.png" />
|
|
88
|
+
|
|
89
|
+
Creates a brand new license key and invalidates the old one.
|
|
90
|
+
|
|
91
|
+
- The old key will immediately stop working
|
|
92
|
+
- Customer must use the new key for future activations
|
|
93
|
+
- Existing activations will stop working
|
|
94
|
+
|
|
95
|
+
> ⚠️ **Warning**: This action cannot be undone. Use when a key has been compromised or shared inappropriately.
|
|
96
|
+
|
|
97
|
+
#### ✏️ Edit Activation Limit
|
|
98
|
+
|
|
99
|
+
<img height="200" src="/images/edit-activation-limit-1.png" />
|
|
100
|
+
|
|
101
|
+
Modify how many devices can use this specific license.
|
|
102
|
+
|
|
103
|
+
- Toggle activation limit on/off
|
|
104
|
+
- Set a specific number (1-100 activations)
|
|
105
|
+
- Changes apply immediately
|
|
106
|
+
|
|
107
|
+
> **Use case**: Upgrade a customer from 3 seats to 10 seats without issuing a new license.
|
|
108
|
+
|
|
109
|
+
#### 📅 Manage Expiry
|
|
110
|
+
|
|
111
|
+
<img height="200" src="/images/manage-expiry.png" />
|
|
112
|
+
|
|
113
|
+
Update the license expiration date.
|
|
114
|
+
|
|
115
|
+
- Toggle expiry on/off
|
|
116
|
+
- Set a specific expiration date using the calendar picker
|
|
117
|
+
- Extend or shorten the validity period
|
|
118
|
+
|
|
119
|
+
> **Use case**: Extend a license by 3 months as a courtesy for a loyal customer.
|
|
120
|
+
|
|
121
|
+
#### ⛔ Deactivate License
|
|
122
|
+
|
|
123
|
+
Permanently disable the entire license.
|
|
124
|
+
|
|
125
|
+
- All existing activations will stop working
|
|
126
|
+
- Customers will no longer be able to activate or validate the key
|
|
127
|
+
- The license key becomes invalid
|
|
128
|
+
|
|
129
|
+
> ⚠️ **Warning**: This action cannot be undone. Use for refunds or policy violations.
|
|
130
|
+
|
|
131
|
+
### Viewing Active Activations
|
|
132
|
+
|
|
133
|
+
Click on the license card to view the **License Details** page, which shows:
|
|
134
|
+
|
|
135
|
+
- All instances where the license is currently activated
|
|
136
|
+
- Instance name or ID
|
|
137
|
+
- Last seen timestamp (when the license was last validated)
|
|
138
|
+
- Activation metadata (device info, if provided)
|
|
139
|
+
|
|
140
|
+
#### Revoking Individual Activations
|
|
141
|
+
|
|
142
|
+
<img height="200" src="/images/revoke-license.png" />
|
|
143
|
+
|
|
144
|
+
For each active instance, you can click **Revoke** to:
|
|
145
|
+
- Remove that specific instance's access
|
|
146
|
+
- Free up an activation slot
|
|
147
|
+
- The license remains valid for other instances
|
|
148
|
+
|
|
149
|
+
> **Use case**: Customer got a new computer and wants to transfer their license. Revoke the old instance to free up a slot.
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## 3. License API for Developers
|
|
154
|
+
|
|
155
|
+
Your customers (or their software) can interact with licenses using these API endpoints. Use these to integrate license checking into your application.
|
|
156
|
+
|
|
157
|
+
### 3.1 Activate a License
|
|
158
|
+
|
|
159
|
+
Activates a license key on a specific device/instance.
|
|
160
|
+
|
|
161
|
+
**Endpoint**: `POST /license/activate`
|
|
162
|
+
|
|
163
|
+
**When to use**:
|
|
164
|
+
- When the user enters their license key for the first time
|
|
165
|
+
- When your application is installed on a new device
|
|
166
|
+
|
|
167
|
+
**What it does**:
|
|
168
|
+
- Validates the license key exists and is valid
|
|
169
|
+
- Checks if activation limit has been reached
|
|
170
|
+
- Creates a new activation instance
|
|
171
|
+
- Returns activation details including instance ID
|
|
172
|
+
|
|
173
|
+
**Key behaviors**:
|
|
174
|
+
- Fails if the license is expired
|
|
175
|
+
- Fails if the license is deactivated
|
|
176
|
+
- Fails if activation limit is reached
|
|
177
|
+
- Succeeds and increments the activation count
|
|
178
|
+
|
|
179
|
+
📖 **Full documentation**: [Activate License API](https://docs.kelviq.com/api-reference/license/activate-license)
|
|
180
|
+
|
|
181
|
+
---
|
|
182
|
+
|
|
183
|
+
### 3.2 Validate a License
|
|
184
|
+
|
|
185
|
+
Checks if a license is valid and currently active.
|
|
186
|
+
|
|
187
|
+
**Endpoint**: `POST /license/validate`
|
|
188
|
+
|
|
189
|
+
**When to use**:
|
|
190
|
+
- On application startup to verify the license
|
|
191
|
+
- Periodically during runtime
|
|
192
|
+
- Before granting access to licensed features
|
|
193
|
+
- When checking license status without activating
|
|
194
|
+
|
|
195
|
+
**What it does**:
|
|
196
|
+
- Confirms the license key exists
|
|
197
|
+
- Checks if the license is active (not deactivated)
|
|
198
|
+
- Verifies the license hasn't expired
|
|
199
|
+
- Returns current license status and metadata
|
|
200
|
+
|
|
201
|
+
**Response includes**:
|
|
202
|
+
- License validity status
|
|
203
|
+
- Expiration date
|
|
204
|
+
- Activation count and limit
|
|
205
|
+
- License metadata
|
|
206
|
+
|
|
207
|
+
📖 **Full documentation**: [Validate License API](https://docs.kelviq.com/api-reference/license/validate-license)
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
211
|
+
### 3.3 Deactivate a License
|
|
212
|
+
|
|
213
|
+
Removes an activation from a specific device/instance.
|
|
214
|
+
|
|
215
|
+
**Endpoint**: `POST /license/deactivate`
|
|
216
|
+
|
|
217
|
+
**When to use**:
|
|
218
|
+
- When the user uninstalls your application
|
|
219
|
+
- When transferring a license to another device
|
|
220
|
+
- When the user explicitly signs out
|
|
221
|
+
|
|
222
|
+
**What it does**:
|
|
223
|
+
- Removes the device/instance from active activations
|
|
224
|
+
- Decrements the activation count
|
|
225
|
+
- Frees up a slot for activation on another device
|
|
226
|
+
- The license itself remains valid
|
|
227
|
+
|
|
228
|
+
**Key behaviors**:
|
|
229
|
+
- Requires both the license key and instance ID
|
|
230
|
+
- Only deactivates the specific instance, not the entire license
|
|
231
|
+
- The license can be re-activated on the same or different device
|
|
232
|
+
|
|
233
|
+
📖 **Full documentation**: [Deactivate License API](https://docs.kelviq.com/api-reference/license/deactivate-license)
|
|
234
|
+
|
|
235
|
+
---
|
|
236
|
+
|
|
237
|
+
## 4. Common Workflows
|
|
238
|
+
|
|
239
|
+
### Workflow A: New Customer Purchase
|
|
240
|
+
|
|
241
|
+
```
|
|
242
|
+
1. Customer purchases a plan with licenses enabled
|
|
243
|
+
2. Order is created → License key is automatically generated
|
|
244
|
+
3. Customer receives license key (via email, dashboard, etc.)
|
|
245
|
+
4. Customer enters key in your application
|
|
246
|
+
5. Application calls Activate API
|
|
247
|
+
6. License is now active on customer's device
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
### Workflow B: Customer Switches Devices
|
|
251
|
+
|
|
252
|
+
```
|
|
253
|
+
1. Customer uninstalls app from old device (calls Deactivate API)
|
|
254
|
+
2. Activation slot is freed
|
|
255
|
+
3. Customer installs app on new device
|
|
256
|
+
4. Customer enters same license key
|
|
257
|
+
5. Application calls Activate API
|
|
258
|
+
6. License is now active on the new device
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### Workflow C: Validating on Application Startup
|
|
262
|
+
|
|
263
|
+
```
|
|
264
|
+
1. Application launches
|
|
265
|
+
2. Check if license was previously activated (stored locally)
|
|
266
|
+
3. Call Validate API with the license key
|
|
267
|
+
4. If valid → Grant access to features
|
|
268
|
+
5. If invalid/expired → Prompt user to renew or re-enter key
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
### Workflow D: Admin Extends a License
|
|
272
|
+
|
|
273
|
+
```
|
|
274
|
+
1. Customer requests extension
|
|
275
|
+
2. Admin opens Order Details
|
|
276
|
+
3. Click license menu → "Manage expiry"
|
|
277
|
+
4. Select new expiration date
|
|
278
|
+
5. Save changes
|
|
279
|
+
6. Customer's next validation will reflect the new expiry
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
### Workflow E: Handling a Compromised Key
|
|
283
|
+
|
|
284
|
+
```
|
|
285
|
+
1. Admin notices suspicious activity (too many activations)
|
|
286
|
+
2. Open Order Details → View License Details
|
|
287
|
+
3. Revoke unauthorized instances
|
|
288
|
+
4. If key is widely leaked: Regenerate the key
|
|
289
|
+
5. Send new key to legitimate customer
|
|
290
|
+
6. Old key stops working immediately
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
295
|
+
## Quick Reference
|
|
296
|
+
|
|
297
|
+
| Task | Where | Action |
|
|
298
|
+
|------|-------|--------|
|
|
299
|
+
| Enable licenses for a plan | Plan Details | Toggle "License keys" switch |
|
|
300
|
+
| Set activation limit (plan) | Plan Details → License keys | Enable limit + set number |
|
|
301
|
+
| Set expiry duration (plan) | Plan Details → License keys | Enable expiry + set duration |
|
|
302
|
+
| View customer's license | Order Details | See license card |
|
|
303
|
+
| Copy license key | Order Details | Click on license key |
|
|
304
|
+
| Regenerate key | Order Details → License menu | "Regenerate key" |
|
|
305
|
+
| Change activation limit | Order Details → License menu | "Edit activation limit" |
|
|
306
|
+
| Change expiry date | Order Details → License menu | "Manage expiry" |
|
|
307
|
+
| View all activations | Order Details | Click license card |
|
|
308
|
+
| Revoke a device | License Details | Click "Revoke" on instance |
|
|
309
|
+
| Deactivate entire license | Order Details → License menu | "Deactivate" |
|
|
310
|
+
|
|
311
|
+
---
|
|
312
|
+
|
|
313
|
+
## Important Notes
|
|
314
|
+
|
|
315
|
+
⚠️ **Irreversible Actions**:
|
|
316
|
+
- **Regenerating a key**: The old key immediately stops working. All existing activations are invalidated.
|
|
317
|
+
- **Deactivating a license**: The license is permanently disabled and cannot be reactivated.
|
|
318
|
+
|
|
319
|
+
✅ **Best Practices**:
|
|
320
|
+
- Set reasonable activation limits based on your pricing model
|
|
321
|
+
- Use the Validate API on application startup for security
|
|
322
|
+
- Store the instance ID locally after activation for proper deactivation
|
|
323
|
+
- Communicate expiry dates clearly to customers before they expire
|
|
324
|
+
- Consider grace periods before fully blocking expired licenses
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Links"
|
|
3
|
+
slug: "product-catalog/links"
|
|
4
|
+
section: "product-catalog"
|
|
5
|
+
description: "Share links with your customers"
|
|
6
|
+
---
|
|
7
|
+
Links allow you to share important URLs with customers after they purchase your plan. Use links to grant access to communities, resources, or any web-based content.
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
Use Links to share:
|
|
12
|
+
- **Community access** – Discord servers, Slack workspaces, or private forums
|
|
13
|
+
- **Knowledge bases** – Notion pages, documentation sites, or wikis
|
|
14
|
+
- **Membership portals** – Member-only websites or dashboards
|
|
15
|
+
- **Resource libraries** – Google Drive folders, Dropbox links, or online courses
|
|
16
|
+
- **Any other web content** your customers need access to
|
|
17
|
+
|
|
18
|
+
## Accessing Links
|
|
19
|
+
|
|
20
|
+
<img height="200" src="/images/accessing-links.png" />
|
|
21
|
+
|
|
22
|
+
1. Navigate to **Products** in the sidebar
|
|
23
|
+
2. Select the product containing your plan
|
|
24
|
+
3. Click on the plan you want to edit
|
|
25
|
+
4. Scroll down to the **Links** section
|
|
26
|
+
5. Click the expand arrow to open the section
|
|
27
|
+
|
|
28
|
+
The section header shows the current count of saved links (e.g., "Links (3)").
|
|
29
|
+
|
|
30
|
+
## Adding Links
|
|
31
|
+
|
|
32
|
+
### How to Add a Link
|
|
33
|
+
|
|
34
|
+
<img height="200" src="/images/adding-links.png" />
|
|
35
|
+
|
|
36
|
+
1. Open the **Links** section
|
|
37
|
+
2. You'll see two input fields:
|
|
38
|
+
- **Link name** – A descriptive name for the link
|
|
39
|
+
- **Link URL** – The full URL starting with `https://`
|
|
40
|
+
3. Enter the link name (e.g., "Private Discord community")
|
|
41
|
+
4. Enter the full URL (e.g., `https://discord.gg/your-invite`)
|
|
42
|
+
5. Click **+ Add link** to add another row if needed
|
|
43
|
+
6. Click **Save** to save all links
|
|
44
|
+
|
|
45
|
+
### Link Name Examples
|
|
46
|
+
|
|
47
|
+
Choose clear, descriptive names that tell customers what they'll access:
|
|
48
|
+
|
|
49
|
+
| Good Examples | Why It Works |
|
|
50
|
+
|---------------|--------------|
|
|
51
|
+
| Private Discord Community | Clear destination |
|
|
52
|
+
| Course Materials (Notion) | Describes content and platform |
|
|
53
|
+
| Member Dashboard | Indicates exclusive access |
|
|
54
|
+
| Resource Library | Explains what's inside |
|
|
55
|
+
|
|
56
|
+
### URL Requirements
|
|
57
|
+
|
|
58
|
+
- URLs must start with `https://` or `http://`
|
|
59
|
+
- URLs must be valid and properly formatted
|
|
60
|
+
- Each link requires both a name and URL to be saved
|
|
61
|
+
|
|
62
|
+
## Managing Links
|
|
63
|
+
|
|
64
|
+
### Edit Existing Links
|
|
65
|
+
|
|
66
|
+
1. Open the **Links** section
|
|
67
|
+
2. Modify the link name or URL directly in the input fields
|
|
68
|
+
3. Click **Save** to update
|
|
69
|
+
|
|
70
|
+
### Remove a Link
|
|
71
|
+
|
|
72
|
+
<img height="200" src="/images/remove-links.png" />
|
|
73
|
+
|
|
74
|
+
1. Open the **Links** section
|
|
75
|
+
2. Click the **×** button next to the link you want to remove
|
|
76
|
+
3. Click **Save** to confirm the removal
|
|
77
|
+
|
|
78
|
+
### Cancel Changes
|
|
79
|
+
|
|
80
|
+
If you've made changes but want to discard them:
|
|
81
|
+
1. Click **Cancel**
|
|
82
|
+
2. All unsaved changes will be reverted to the last saved state
|
|
83
|
+
|
|
84
|
+
## Customer Experience
|
|
85
|
+
|
|
86
|
+
After a successful purchase, customers can:
|
|
87
|
+
|
|
88
|
+
1. Access the order confirmation page
|
|
89
|
+
2. View all links associated with their purchased plan
|
|
90
|
+
3. Click any link to open it in a new tab
|
|
91
|
+
|
|
92
|
+
Links remain accessible to customers as long as their subscription or purchase is active.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Location based pricing"
|
|
3
|
+
slug: "product-catalog/location-based-pricing"
|
|
4
|
+
section: "product-catalog"
|
|
5
|
+
description: "Set custom prices for specific countries to optimize global conversion"
|
|
6
|
+
---
|
|
7
|
+
Location based pricing is a feature that allows you to set custom prices for specific countries to optimize global conversion.
|
|
8
|
+
|
|
9
|
+
## Set up localized prices
|
|
10
|
+
|
|
11
|
+
To offer a localized price open your plan configuration and expand the Price localization card.
|
|
12
|
+
|
|
13
|
+
### 1. Choose a currency
|
|
14
|
+
|
|
15
|
+
Select your target currency from the dropdown list. You can choose options like Euro or Indian Rupee. Click Add localized price to open the configuration panel.
|
|
16
|
+
|
|
17
|
+
<img height="200" src="/images/choose-currency.png" />
|
|
18
|
+
|
|
19
|
+
### 2. Set the fixed base charge
|
|
20
|
+
|
|
21
|
+
Kelviq automatically displays the billing cycles you already enabled for your default base price and usage based pricing. Enter the exact localized amount you want to charge for each active interval.
|
|
22
|
+
|
|
23
|
+
<img height="400" src="/images/base-pricing.png" />
|
|
24
|
+
|
|
25
|
+
### 3. Localize usage based features
|
|
26
|
+
|
|
27
|
+
If your plan includes metered features like API calls Kelviq pulls those in automatically right below the fixed charge section. You can set localized unit prices and flat fees for every single usage tier.
|
|
28
|
+
|
|
29
|
+
You must configure these usage rates across all active billing periods. Use the tabs to switch between your monthly and yearly configurations and ensure every input has a defined price.
|
|
30
|
+
|
|
31
|
+
<img height="600" src="/images/usage-pricing.png" />
|
|
32
|
+
|
|
33
|
+
### 4. Save and stack regions
|
|
34
|
+
|
|
35
|
+
Click Save to lock in the location based pricing configuration. The currency will appear in your localized pricing list.
|
|
36
|
+
|
|
37
|
+
You can repeat this process to add as many localized currencies as you need.
|
|
38
|
+
|
|
39
|
+
## Fraud protection
|
|
40
|
+
|
|
41
|
+
Kelviq analyzes the IP address, browser fingerprint, and issuing bank of the credit card during checkout. If a customer attempts to use a card from a high income country while pretending to be in a lower income region we block the transaction or force the standard global price automatically.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "One time payments"
|
|
3
|
+
slug: "product-catalog/one-time-payments"
|
|
4
|
+
section: "product-catalog"
|
|
5
|
+
description: "Charge a flat fee for lifetime access or digital downloads"
|
|
6
|
+
---
|
|
7
|
+
Not every product needs a subscription. If you are selling a lifetime software license, a template, or charging a one time setup fee for an AI agent, you use a flat base price.
|
|
8
|
+
|
|
9
|
+
## Set up a one time price
|
|
10
|
+
|
|
11
|
+
<img height="200" src="/images/One-time.png" />
|
|
12
|
+
|
|
13
|
+
1. Open your draft plan and ensure it is set to Paid
|
|
14
|
+
2. Under the billing cycles select One time
|
|
15
|
+
3. Enter the total amount you want to charge
|
|
16
|
+
4. Click Save
|
|
17
|
+
|
|
18
|
+
Customers pay this amount exactly once during checkout. If you attach digital downloads or license keys to this plan they gain permanent access to those assets immediately after payment.
|
|
19
|
+
|
|
20
|
+
## Combine with usage
|
|
21
|
+
|
|
22
|
+
You can charge a one time setup fee and still bill for ongoing usage.
|
|
23
|
+
|
|
24
|
+
Just select One time for the base fee and add your metered features below it. The customer pays the base price upfront to gain access and then pays for their compute or token usage at the end of each billing period.
|