@kelviq/mcp-server 0.2.3 → 0.3.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 (42) hide show
  1. package/README.md +21 -17
  2. package/dist/config.d.ts +8 -1
  3. package/dist/config.js +37 -6
  4. package/dist/config.js.map +1 -1
  5. package/dist/docs/api-reference/authentication.md +7 -3
  6. package/dist/docs/api-reference/introduction.md +143 -0
  7. package/dist/docs/backend-integration/node-sdk.md +148 -6
  8. package/dist/docs/backend-integration/python-sdk.md +195 -11
  9. package/dist/docs/changelog/api.md +119 -0
  10. package/dist/docs/changelog/app.md +693 -0
  11. package/dist/docs/changelog/node-sdk.md +153 -0
  12. package/dist/docs/changelog/python-sdk.md +182 -0
  13. package/dist/docs/cli/commands.md +225 -0
  14. package/dist/docs/cli/environments.md +95 -0
  15. package/dist/docs/cli/kelviq-config.md +141 -0
  16. package/dist/docs/cli/overview.md +223 -0
  17. package/dist/docs/customer-portal/managing-payment-methods.md +72 -0
  18. package/dist/docs/guides/mcp-server.md +129 -173
  19. package/dist/docs/guides/sandbox.md +107 -0
  20. package/dist/docs/guides/webhooks.md +81 -0
  21. package/dist/docs/manifest.json +57 -8
  22. package/dist/docs/openapi.json +1206 -50
  23. package/dist/docs/product-catalog/one-time-payments.md +3 -1
  24. package/dist/docs/product-catalog/usage-based-billing.md +86 -7
  25. package/dist/docs/quickstart/dashboard-setup.md +1 -1
  26. package/dist/schemas/kelviq.d.ts +0 -128
  27. package/dist/schemas/kelviq.js +0 -63
  28. package/dist/schemas/kelviq.js.map +1 -1
  29. package/dist/tools/index.js +0 -4
  30. package/dist/tools/index.js.map +1 -1
  31. package/dist/tools/plan-files.js +1 -1
  32. package/dist/tools/plan-files.js.map +1 -1
  33. package/dist/tools/plans.js +1 -15
  34. package/dist/tools/plans.js.map +1 -1
  35. package/dist/tools/portal.d.ts +11 -1
  36. package/dist/tools/portal.js +27 -2
  37. package/dist/tools/portal.js.map +1 -1
  38. package/dist/tools/products.js +1 -1
  39. package/dist/tools/products.js.map +1 -1
  40. package/dist/tools/subscriptions.js +1 -1
  41. package/dist/tools/subscriptions.js.map +1 -1
  42. package/package.json +5 -2
@@ -100,6 +100,20 @@ The request body is a JSON object with the following top-level fields:
100
100
  "status": "success",
101
101
  "checkout_type": "ONE_TIME",
102
102
  "customer_id": "936cf361-3a4b-454c-a464-41ccc7600c2d",
103
+ "customer": {
104
+ "id": "936cf361-3a4b-454c-a464-41ccc7600c2d",
105
+ "name": "Geo Jacob",
106
+ "email": "geojacob@example.com",
107
+ "customer_id": "geo-jacob",
108
+ "billing_address": {
109
+ "line1": null,
110
+ "line2": null,
111
+ "city": null,
112
+ "state": null,
113
+ "postal_code": "680121",
114
+ "country": "IN"
115
+ }
116
+ },
103
117
  "organization": "9b759915-5387-4e61-90e9-2162318e8d17",
104
118
  "amount": "10.00",
105
119
  "amount_units": 1000,
@@ -124,6 +138,10 @@ The request body is a JSON object with the following top-level fields:
124
138
  "country": "IN"
125
139
  },
126
140
  "metadata": {
141
+ "order_ref": "ABC-123",
142
+ "source": "pricing_page"
143
+ },
144
+ "data": {
127
145
  "name": "Geo",
128
146
  "email": "geojacob@example.com",
129
147
  "referer": null,
@@ -202,6 +220,13 @@ The request body is a JSON object with the following top-level fields:
202
220
  "status": "COMPLETE",
203
221
  "billing_type": "ONE_TIME",
204
222
  "customer_id": "936cf361-3a4b-454c-a464-41ccc7600c2d",
223
+ "customer": {
224
+ "id": "936cf361-3a4b-454c-a464-41ccc7600c2d",
225
+ "name": "Geo Jacob",
226
+ "email": "geojacob@example.com",
227
+ "customer_id": "geo-jacob",
228
+ "billing_address": {}
229
+ },
205
230
  "organization": "9b759915-5387-4e61-90e9-2162318e8d17",
206
231
  "is_renewal": false,
207
232
  "paid_at": "2026-04-01T17:36:41Z",
@@ -238,6 +263,20 @@ The request body is a JSON object with the following top-level fields:
238
263
  "status": "COMPLETE",
239
264
  "billing_type": "ONE_TIME",
240
265
  "customer_id": "936cf361-3a4b-454c-a464-41ccc7600c2d",
266
+ "customer": {
267
+ "id": "936cf361-3a4b-454c-a464-41ccc7600c2d",
268
+ "name": "Geo Jacob",
269
+ "email": "geojacob@example.com",
270
+ "customer_id": "geo-jacob",
271
+ "billing_address": {
272
+ "line1": null,
273
+ "line2": null,
274
+ "city": null,
275
+ "state": null,
276
+ "postal_code": "680121",
277
+ "country": "IN"
278
+ }
279
+ },
241
280
  "organization": "9b759915-5387-4e61-90e9-2162318e8d17",
242
281
  "is_renewal": false,
243
282
  "paid_at": "2026-04-01T17:36:41Z",
@@ -277,6 +316,20 @@ The request body is a JSON object with the following top-level fields:
277
316
  "status": "REFUNDED",
278
317
  "billing_type": "ONE_TIME",
279
318
  "customer_id": "936cf361-3a4b-454c-a464-41ccc7600c2d",
319
+ "customer": {
320
+ "id": "936cf361-3a4b-454c-a464-41ccc7600c2d",
321
+ "name": "Geo Jacob",
322
+ "email": "geojacob@example.com",
323
+ "customer_id": "geo-jacob",
324
+ "billing_address": {
325
+ "line1": null,
326
+ "line2": null,
327
+ "city": null,
328
+ "state": null,
329
+ "postal_code": "680121",
330
+ "country": "IN"
331
+ }
332
+ },
280
333
  "organization": "9b759915-5387-4e61-90e9-2162318e8d17",
281
334
  "is_renewal": false,
282
335
  "paid_at": "2026-04-01T17:36:41Z",
@@ -598,6 +651,20 @@ The request body is a JSON object with the following top-level fields:
598
651
  "due_date": null,
599
652
  "order_id": null,
600
653
  "customer_id": "c479275c-6987-4e0b-9aca-46e6e83226aa",
654
+ "customer": {
655
+ "id": "c479275c-6987-4e0b-9aca-46e6e83226aa",
656
+ "name": "Geo Jacob",
657
+ "email": "geojacob@example.com",
658
+ "customer_id": "geo-jacob",
659
+ "billing_address": {
660
+ "line1": null,
661
+ "line2": null,
662
+ "city": null,
663
+ "state": null,
664
+ "postal_code": "680121",
665
+ "country": "IN"
666
+ }
667
+ },
601
668
  "subscription_id": "a2951973-aca5-408d-bd9c-1d86827ed463",
602
669
  "organization": "9b759915-5387-4e61-90e9-2162318e8d17",
603
670
  "product": {
@@ -628,6 +695,20 @@ The request body is a JSON object with the following top-level fields:
628
695
  "due_date": null,
629
696
  "order_id": null,
630
697
  "customer_id": "c479275c-6987-4e0b-9aca-46e6e83226aa",
698
+ "customer": {
699
+ "id": "c479275c-6987-4e0b-9aca-46e6e83226aa",
700
+ "name": "Geo Jacob",
701
+ "email": "geojacob@example.com",
702
+ "customer_id": "geo-jacob",
703
+ "billing_address": {
704
+ "line1": null,
705
+ "line2": null,
706
+ "city": null,
707
+ "state": null,
708
+ "postal_code": "680121",
709
+ "country": "IN"
710
+ }
711
+ },
631
712
  "subscription_id": "a2951973-aca5-408d-bd9c-1d86827ed463",
632
713
  "organization": "9b759915-5387-4e61-90e9-2162318e8d17",
633
714
  "product": {
@@ -3,9 +3,16 @@
3
3
  "slug": "api-reference/authentication",
4
4
  "section": "api-reference",
5
5
  "title": "Authentication",
6
- "description": null,
6
+ "description": "Authenticate securely with environment-scoped Kelviq API keys",
7
7
  "path": "api-reference/authentication.md"
8
8
  },
9
+ {
10
+ "slug": "api-reference/introduction",
11
+ "section": "api-reference",
12
+ "title": "Introduction",
13
+ "description": "Base URLs, environments, and authentication for the Kelviq API",
14
+ "path": "api-reference/introduction.md"
15
+ },
9
16
  {
10
17
  "slug": "backend-integration/node-sdk",
11
18
  "section": "backend-integration",
@@ -20,6 +27,13 @@
20
27
  "description": "Documentation for the Kelviq Python SDK",
21
28
  "path": "backend-integration/python-sdk.md"
22
29
  },
30
+ {
31
+ "slug": "changelog/api",
32
+ "section": "changelog",
33
+ "title": "API",
34
+ "description": "Changelog for the Kelviq API",
35
+ "path": "changelog/api.md"
36
+ },
23
37
  {
24
38
  "slug": "changelog/app",
25
39
  "section": "changelog",
@@ -27,13 +41,6 @@
27
41
  "description": "Changelog for the Kelviq Dashboard",
28
42
  "path": "changelog/app.md"
29
43
  },
30
- {
31
- "slug": "changelog/checkout-api",
32
- "section": "changelog",
33
- "title": "Checkout API",
34
- "description": "Changelog for Checkout API",
35
- "path": "changelog/checkout-api.md"
36
- },
37
44
  {
38
45
  "slug": "changelog/js-promotions-ui",
39
46
  "section": "changelog",
@@ -76,6 +83,34 @@
76
83
  "description": "Configure and customize checkout experiences for your customers",
77
84
  "path": "checkout/checkout-configuration.md"
78
85
  },
86
+ {
87
+ "slug": "cli/commands",
88
+ "section": "cli",
89
+ "title": "Command reference",
90
+ "description": "Every Kelviq CLI command, flag by flag.",
91
+ "path": "cli/commands.md"
92
+ },
93
+ {
94
+ "slug": "cli/environments",
95
+ "section": "cli",
96
+ "title": "Environments & authentication",
97
+ "description": "How the CLI targets sandbox vs. production, where keys live, and how to authenticate in CI.",
98
+ "path": "cli/environments.md"
99
+ },
100
+ {
101
+ "slug": "cli/kelviq-config",
102
+ "section": "cli",
103
+ "title": "kelviq.config.ts reference",
104
+ "description": "The pricing-as-code file format: builders, fields, and the rules that keep it portable.",
105
+ "path": "cli/kelviq-config.md"
106
+ },
107
+ {
108
+ "slug": "cli/overview",
109
+ "section": "cli",
110
+ "title": "Kelviq CLI",
111
+ "description": "Pricing-as-code for Kelviq — define your products, features, and plans in TypeScript and sync them with your account from the terminal.",
112
+ "path": "cli/overview.md"
113
+ },
79
114
  {
80
115
  "slug": "coustomers-management/overview",
81
116
  "section": "coustomers-management",
@@ -83,6 +118,13 @@
83
118
  "description": "View and manage customer details, subscriptions, and entitlements.",
84
119
  "path": "coustomers-management/overview.md"
85
120
  },
121
+ {
122
+ "slug": "customer-portal/managing-payment-methods",
123
+ "section": "customer-portal",
124
+ "title": "Managing Your Payment Methods",
125
+ "description": "A guide for managing payment methods for your subscriptions.",
126
+ "path": "customer-portal/managing-payment-methods.md"
127
+ },
86
128
  {
87
129
  "slug": "customer-portal/overview",
88
130
  "section": "customer-portal",
@@ -160,6 +202,13 @@
160
202
  "description": "Control Kelviq from Claude, Cursor, and any AI assistant that speaks the Model Context Protocol.",
161
203
  "path": "guides/mcp-server.md"
162
204
  },
205
+ {
206
+ "slug": "guides/sandbox",
207
+ "section": "guides",
208
+ "title": "Sandbox",
209
+ "description": "Build and test your Kelviq integration without affecting production data or processing real payments",
210
+ "path": "guides/sandbox.md"
211
+ },
163
212
  {
164
213
  "slug": "guides/subscription-integration",
165
214
  "section": "guides",