@kelviq/mcp-server 0.4.0 → 1.1.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.
Files changed (76) hide show
  1. package/README.md +43 -27
  2. package/dist/config.d.ts +4 -0
  3. package/dist/config.js +30 -9
  4. package/dist/config.js.map +1 -1
  5. package/dist/docs/README.md +16 -0
  6. package/dist/docs/backend-integration/better-auth.md +369 -0
  7. package/dist/docs/backend-integration/node-sdk.md +373 -5
  8. package/dist/docs/backend-integration/python-sdk.md +444 -6
  9. package/dist/docs/changelog/api.md +516 -5
  10. package/dist/docs/changelog/app.md +162 -0
  11. package/dist/docs/changelog/cli.md +33 -0
  12. package/dist/docs/changelog/mcp-server.md +23 -0
  13. package/dist/docs/changelog/node-sdk.md +124 -0
  14. package/dist/docs/changelog/python-sdk.md +135 -0
  15. package/dist/docs/changelog.md +3968 -0
  16. package/dist/docs/checkout/apply-a-discount-code.md +150 -0
  17. package/dist/docs/checkout/checkout-configuration.md +88 -22
  18. package/dist/docs/checkout/checkout-metadata.md +219 -0
  19. package/dist/docs/checkout/static-checkout-url.md +201 -0
  20. package/dist/docs/cli/commands.md +1 -1
  21. package/dist/docs/cli/environments.md +17 -9
  22. package/dist/docs/cli/kelviq-config.md +35 -1
  23. package/dist/docs/cli/overview.md +2 -0
  24. package/dist/docs/coustomers-management/overview.md +15 -19
  25. package/dist/docs/customer-portal/managing-payment-methods.md +30 -48
  26. package/dist/docs/frontend-integration/react-ui.md +51 -16
  27. package/dist/docs/getstarted/fees.md +45 -54
  28. package/dist/docs/getstarted/payment-security-and-seller-funds.md +98 -0
  29. package/dist/docs/getstarted/review-process.md +3 -3
  30. package/dist/docs/guides/agent-toolkit.md +143 -0
  31. package/dist/docs/guides/mcp-server.md +138 -35
  32. package/dist/docs/guides/migrate-from-cashfree.md +7 -0
  33. package/dist/docs/guides/sandbox.md +34 -0
  34. package/dist/docs/guides/subscription-integration-for-nextjs.md +44 -18
  35. package/dist/docs/guides/subscription-integration.md +28 -4
  36. package/dist/docs/guides/webhooks.md +367 -6
  37. package/dist/docs/manifest.json +98 -56
  38. package/dist/docs/openapi.json +7411 -2648
  39. package/dist/docs/payouts/overview.md +30 -0
  40. package/dist/docs/payouts/transactions.md +50 -6
  41. package/dist/docs/product-catalog/create-a-feature.md +113 -0
  42. package/dist/docs/product-catalog/create-an-enterprise-plan.md +133 -0
  43. package/dist/docs/product-catalog/discounts.md +25 -12
  44. package/dist/docs/product-catalog/entitlements.md +53 -16
  45. package/dist/docs/product-catalog/free-and-trials.md +8 -4
  46. package/dist/docs/product-catalog/location-based-pricing.md +2 -0
  47. package/dist/docs/product-catalog/one-time-payments.md +4 -0
  48. package/dist/docs/product-catalog/pay-as-you-go.md +177 -0
  49. package/dist/docs/product-catalog/plans.md +14 -0
  50. package/dist/docs/product-catalog/products.md +5 -13
  51. package/dist/docs/product-catalog/seat-based-pricing.md +233 -0
  52. package/dist/docs/product-catalog/subscriptions.md +109 -12
  53. package/dist/docs/product-catalog/usage-alerts.md +257 -0
  54. package/dist/docs/product-catalog/usage-based-billing.md +49 -12
  55. package/dist/docs/quickstart/dashboard-setup.md +1 -1
  56. package/dist/docs/sales/abandoned-cart-recovery.md +64 -0
  57. package/dist/docs/sales/create-a-one-time-charge.md +144 -0
  58. package/dist/http/client.js +9 -2
  59. package/dist/http/client.js.map +1 -1
  60. package/dist/http/errors.d.ts +8 -0
  61. package/dist/http/errors.js +20 -0
  62. package/dist/http/errors.js.map +1 -1
  63. package/dist/schemas/kelviq.d.ts +199 -0
  64. package/dist/schemas/kelviq.js +173 -0
  65. package/dist/schemas/kelviq.js.map +1 -1
  66. package/dist/server.js +11 -1
  67. package/dist/server.js.map +1 -1
  68. package/dist/tools/discounts.d.ts +3 -0
  69. package/dist/tools/discounts.js +74 -0
  70. package/dist/tools/discounts.js.map +1 -0
  71. package/dist/tools/index.js +4 -0
  72. package/dist/tools/index.js.map +1 -1
  73. package/dist/tools/webhooks.d.ts +10 -0
  74. package/dist/tools/webhooks.js +114 -0
  75. package/dist/tools/webhooks.js.map +1 -0
  76. package/package.json +1 -1
@@ -28,60 +28,18 @@
28
28
  "path": "backend-integration/python-sdk.md"
29
29
  },
30
30
  {
31
- "slug": "changelog/api",
32
- "section": "changelog",
33
- "title": "API",
34
- "description": "Changelog for the Kelviq API",
35
- "path": "changelog/api.md"
31
+ "slug": "changelog",
32
+ "section": "root",
33
+ "title": "Changelog",
34
+ "description": "Every Kelviq release across the dashboard, API, SDKs, and developer tools",
35
+ "path": "changelog.md"
36
36
  },
37
37
  {
38
- "slug": "changelog/app",
39
- "section": "changelog",
40
- "title": "App",
41
- "description": "Changelog for the Kelviq Dashboard",
42
- "path": "changelog/app.md"
43
- },
44
- {
45
- "slug": "changelog/js-promotions-ui",
46
- "section": "changelog",
47
- "title": "JS Promotions UI",
48
- "description": "Changelog for @kelviq/js-promotions-ui",
49
- "path": "changelog/js-promotions-ui.md"
50
- },
51
- {
52
- "slug": "changelog/js-sdk",
53
- "section": "changelog",
54
- "title": "JS SDK",
55
- "description": "Changelog for @kelviq/js-sdk",
56
- "path": "changelog/js-sdk.md"
57
- },
58
- {
59
- "slug": "changelog/mcp-server",
60
- "section": "changelog",
61
- "title": "MCP Server",
62
- "description": "Changelog for @kelviq/mcp-server",
63
- "path": "changelog/mcp-server.md"
64
- },
65
- {
66
- "slug": "changelog/node-sdk",
67
- "section": "changelog",
68
- "title": "Node SDK",
69
- "description": "Changelog for @kelviq/node-sdk",
70
- "path": "changelog/node-sdk.md"
71
- },
72
- {
73
- "slug": "changelog/python-sdk",
74
- "section": "changelog",
75
- "title": "Python SDK",
76
- "description": "Changelog for kelviq-sdk (Python)",
77
- "path": "changelog/python-sdk.md"
78
- },
79
- {
80
- "slug": "changelog/react-sdk",
81
- "section": "changelog",
82
- "title": "React SDK",
83
- "description": "Changelog for @kelviq/react-sdk",
84
- "path": "changelog/react-sdk.md"
38
+ "slug": "checkout/apply-a-discount-code",
39
+ "section": "checkout",
40
+ "title": "Apply a discount code at checkout",
41
+ "description": "Let customers enter a discount code or pre-apply one to a Kelviq checkout",
42
+ "path": "checkout/apply-a-discount-code.md"
85
43
  },
86
44
  {
87
45
  "slug": "checkout/checkout-configuration",
@@ -90,6 +48,20 @@
90
48
  "description": "Configure and customize checkout experiences for your customers",
91
49
  "path": "checkout/checkout-configuration.md"
92
50
  },
51
+ {
52
+ "slug": "checkout/checkout-metadata",
53
+ "section": "checkout",
54
+ "title": "Add metadata to checkout",
55
+ "description": "Attach your own IDs and context to a checkout session, then read them from the checkout.completed webhook",
56
+ "path": "checkout/checkout-metadata.md"
57
+ },
58
+ {
59
+ "slug": "checkout/static-checkout-url",
60
+ "section": "checkout",
61
+ "title": "Customize a static checkout URL",
62
+ "description": "Choose plans, set a billing period, attach a customer, apply a discount, and control the success redirect in a Kelviq checkout link",
63
+ "path": "checkout/static-checkout-url.md"
64
+ },
93
65
  {
94
66
  "slug": "cli/commands",
95
67
  "section": "cli",
@@ -128,8 +100,8 @@
128
100
  {
129
101
  "slug": "customer-portal/managing-payment-methods",
130
102
  "section": "customer-portal",
131
- "title": "Managing Your Payment Methods",
132
- "description": "A guide for managing payment methods for your subscriptions.",
103
+ "title": "Managing payment methods",
104
+ "description": "How your customers add, update, and remove payment methods",
133
105
  "path": "customer-portal/managing-payment-methods.md"
134
106
  },
135
107
  {
@@ -178,7 +150,7 @@
178
150
  "slug": "getstarted/fees",
179
151
  "section": "getstarted",
180
152
  "title": "Fees",
181
- "description": "Kelviq's transparent pricing structure",
153
+ "description": "Understand Kelviq's transaction fees and additional charges",
182
154
  "path": "getstarted/fees.md"
183
155
  },
184
156
  {
@@ -195,6 +167,13 @@
195
167
  "description": null,
196
168
  "path": "getstarted/merchant-of-record.md"
197
169
  },
170
+ {
171
+ "slug": "getstarted/payment-security-and-seller-funds",
172
+ "section": "getstarted",
173
+ "title": "Payment security and seller funds",
174
+ "description": "How Kelviq protects card details, routes payments through Stripe, and handles payouts, account reviews, and migrations",
175
+ "path": "getstarted/payment-security-and-seller-funds.md"
176
+ },
198
177
  {
199
178
  "slug": "getstarted/review-process",
200
179
  "section": "getstarted",
@@ -202,6 +181,13 @@
202
181
  "description": null,
203
182
  "path": "getstarted/review-process.md"
204
183
  },
184
+ {
185
+ "slug": "guides/agent-toolkit",
186
+ "section": "guides",
187
+ "title": "Agent Toolkit",
188
+ "description": "Install Kelviq into Claude Code with one plugin — or add the Kelviq skills to any of 70+ AI coding agents.",
189
+ "path": "guides/agent-toolkit.md"
190
+ },
205
191
  {
206
192
  "slug": "guides/mcp-server",
207
193
  "section": "guides",
@@ -209,6 +195,13 @@
209
195
  "description": "Control Kelviq from Claude, Cursor, and any AI assistant that speaks the Model Context Protocol.",
210
196
  "path": "guides/mcp-server.md"
211
197
  },
198
+ {
199
+ "slug": "guides/migrate-from-cashfree",
200
+ "section": "guides",
201
+ "title": "Migrate from Cashfree",
202
+ "description": "Get help moving from Cashfree to Kelviq",
203
+ "path": "guides/migrate-from-cashfree.md"
204
+ },
212
205
  {
213
206
  "slug": "guides/sandbox",
214
207
  "section": "guides",
@@ -321,6 +314,20 @@
321
314
  "description": "Audit individual payments, fees, and net earnings",
322
315
  "path": "payouts/transactions.md"
323
316
  },
317
+ {
318
+ "slug": "product-catalog/create-a-feature",
319
+ "section": "product-catalog",
320
+ "title": "Create a feature in Kelviq",
321
+ "description": "Create Boolean, Meter, or Customizable features in the Kelviq dashboard or with the API, then add them to a plan as entitlements.",
322
+ "path": "product-catalog/create-a-feature.md"
323
+ },
324
+ {
325
+ "slug": "product-catalog/create-an-enterprise-plan",
326
+ "section": "product-catalog",
327
+ "title": "Create an Enterprise plan",
328
+ "description": "Set up a reusable Enterprise tier or a bespoke customer deal in Kelviq",
329
+ "path": "product-catalog/create-an-enterprise-plan.md"
330
+ },
324
331
  {
325
332
  "slug": "product-catalog/digital-downloads",
326
333
  "section": "product-catalog",
@@ -377,6 +384,13 @@
377
384
  "description": "Charge a flat fee for lifetime access or digital downloads",
378
385
  "path": "product-catalog/one-time-payments.md"
379
386
  },
387
+ {
388
+ "slug": "product-catalog/pay-as-you-go",
389
+ "section": "product-catalog",
390
+ "title": "Pay as you go",
391
+ "description": "Bill customers each month for the usage they record",
392
+ "path": "product-catalog/pay-as-you-go.md"
393
+ },
380
394
  {
381
395
  "slug": "product-catalog/plans",
382
396
  "section": "product-catalog",
@@ -391,11 +405,18 @@
391
405
  "description": "Create and manage your high-level product containers",
392
406
  "path": "product-catalog/products.md"
393
407
  },
408
+ {
409
+ "slug": "product-catalog/seat-based-pricing",
410
+ "section": "product-catalog",
411
+ "title": "Seat based pricing",
412
+ "description": "Charge teams for the number of seats they purchase",
413
+ "path": "product-catalog/seat-based-pricing.md"
414
+ },
394
415
  {
395
416
  "slug": "product-catalog/subscriptions",
396
417
  "section": "product-catalog",
397
418
  "title": "Subscriptions",
398
- "description": "Set up monthly or yearly billing for ongoing access",
419
+ "description": "Set up recurring billing and understand renewals and failed payments",
399
420
  "path": "product-catalog/subscriptions.md"
400
421
  },
401
422
  {
@@ -405,6 +426,13 @@
405
426
  "description": "Configure price display rules and B2B exemptions",
406
427
  "path": "product-catalog/tax-settings.md"
407
428
  },
429
+ {
430
+ "slug": "product-catalog/usage-alerts",
431
+ "section": "product-catalog",
432
+ "title": "Usage alerts",
433
+ "description": "Configure usage thresholds and receive feature.usage_alert webhooks",
434
+ "path": "product-catalog/usage-alerts.md"
435
+ },
408
436
  {
409
437
  "slug": "product-catalog/usage-based-billing",
410
438
  "section": "product-catalog",
@@ -461,6 +489,13 @@
461
489
  "description": null,
462
490
  "path": "quickstart/integrate-with-your-app.md"
463
491
  },
492
+ {
493
+ "slug": "sales/abandoned-cart-recovery",
494
+ "section": "sales",
495
+ "title": "Abandoned cart recovery",
496
+ "description": "Automatically remind customers who start checkout but do not pay",
497
+ "path": "sales/abandoned-cart-recovery.md"
498
+ },
464
499
  {
465
500
  "slug": "sales/checkout-sessions",
466
501
  "section": "sales",
@@ -468,6 +503,13 @@
468
503
  "description": "Monitor live traffic and debug failed purchase attempts",
469
504
  "path": "sales/checkout-sessions.md"
470
505
  },
506
+ {
507
+ "slug": "sales/create-a-one-time-charge",
508
+ "section": "sales",
509
+ "title": "Create a one-time charge",
510
+ "description": "Charge a customer's saved payment method without sending them through checkout",
511
+ "path": "sales/create-a-one-time-charge.md"
512
+ },
471
513
  {
472
514
  "slug": "sales/orders",
473
515
  "section": "sales",