@kelviq/mcp-server 0.2.3 → 0.4.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/README.md +26 -23
- package/dist/config.d.ts +9 -1
- package/dist/config.js +38 -7
- package/dist/config.js.map +1 -1
- package/dist/docs/api-reference/authentication.md +7 -3
- package/dist/docs/api-reference/introduction.md +143 -0
- package/dist/docs/backend-integration/node-sdk.md +148 -6
- package/dist/docs/backend-integration/python-sdk.md +195 -11
- package/dist/docs/changelog/api.md +119 -0
- package/dist/docs/changelog/app.md +693 -0
- package/dist/docs/changelog/mcp-server.md +61 -0
- package/dist/docs/changelog/node-sdk.md +153 -0
- package/dist/docs/changelog/python-sdk.md +182 -0
- package/dist/docs/cli/commands.md +225 -0
- package/dist/docs/cli/environments.md +95 -0
- package/dist/docs/cli/kelviq-config.md +141 -0
- package/dist/docs/cli/overview.md +223 -0
- package/dist/docs/customer-portal/managing-payment-methods.md +72 -0
- package/dist/docs/guides/mcp-server.md +141 -194
- package/dist/docs/guides/sandbox.md +107 -0
- package/dist/docs/guides/webhooks.md +81 -0
- package/dist/docs/manifest.json +64 -8
- package/dist/docs/openapi.json +1206 -50
- package/dist/docs/product-catalog/one-time-payments.md +3 -1
- package/dist/docs/product-catalog/usage-based-billing.md +86 -7
- package/dist/docs/quickstart/dashboard-setup.md +1 -1
- package/dist/prompts/index.d.ts +2 -0
- package/dist/prompts/index.js +107 -0
- package/dist/prompts/index.js.map +1 -0
- package/dist/schemas/kelviq.d.ts +30 -128
- package/dist/schemas/kelviq.js +50 -63
- package/dist/schemas/kelviq.js.map +1 -1
- package/dist/server.js +5 -2
- package/dist/server.js.map +1 -1
- package/dist/tools/checkout.js +2 -1
- package/dist/tools/checkout.js.map +1 -1
- package/dist/tools/customers.js +2 -0
- package/dist/tools/customers.js.map +1 -1
- package/dist/tools/docs.js +2 -0
- package/dist/tools/docs.js.map +1 -1
- package/dist/tools/entitlements.js +1 -0
- package/dist/tools/entitlements.js.map +1 -1
- package/dist/tools/features.js +4 -0
- package/dist/tools/features.js.map +1 -1
- package/dist/tools/index.js +0 -4
- package/dist/tools/index.js.map +1 -1
- package/dist/tools/licenses.js +3 -0
- package/dist/tools/licenses.js.map +1 -1
- package/dist/tools/offerings.js +1 -0
- package/dist/tools/offerings.js.map +1 -1
- package/dist/tools/plan-entitlements.js +4 -0
- package/dist/tools/plan-entitlements.js.map +1 -1
- package/dist/tools/plan-files.js +4 -1
- package/dist/tools/plan-files.js.map +1 -1
- package/dist/tools/plans.js +9 -15
- package/dist/tools/plans.js.map +1 -1
- package/dist/tools/portal.d.ts +11 -1
- package/dist/tools/portal.js +28 -2
- package/dist/tools/portal.js.map +1 -1
- package/dist/tools/product-files.js +2 -0
- package/dist/tools/product-files.js.map +1 -1
- package/dist/tools/product-settings.js +2 -0
- package/dist/tools/product-settings.js.map +1 -1
- package/dist/tools/products.js +6 -1
- package/dist/tools/products.js.map +1 -1
- package/dist/tools/promotions.js +1 -0
- package/dist/tools/promotions.js.map +1 -1
- package/dist/tools/subscriptions.js +6 -2
- package/dist/tools/subscriptions.js.map +1 -1
- package/dist/tools/usage.js +1 -0
- package/dist/tools/usage.js.map +1 -1
- package/package.json +5 -2
|
@@ -21,4 +21,6 @@ Customers pay this amount exactly once during checkout. If you attach digital do
|
|
|
21
21
|
|
|
22
22
|
You can charge a one time setup fee and still bill for ongoing usage.
|
|
23
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.
|
|
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.
|
|
25
|
+
|
|
26
|
+
Please note that when combining a one-time base fee with metered features, the usage-based pricing models are limited to **flat** and **package** pricing options.
|
|
@@ -42,7 +42,19 @@ Kelviq supports five distinct ways to calculate the cost. Here is how the math w
|
|
|
42
42
|
|
|
43
43
|
#### Flat
|
|
44
44
|
|
|
45
|
-
|
|
45
|
+
The simplest way to charge for usage. Set one fixed rate for every unit consumed. No tiers, packages, or volume discounts. The total scales directly with usage.
|
|
46
|
+
|
|
47
|
+
**Best for** API products and services where the cost of serving each unit stays relatively consistent.
|
|
48
|
+
|
|
49
|
+
**Example** A translation API charging for each character processed.
|
|
50
|
+
|
|
51
|
+
**Sample calculation**
|
|
52
|
+
|
|
53
|
+
| | |
|
|
54
|
+
| --- | --- |
|
|
55
|
+
| Rate | \$0.01 per API call |
|
|
56
|
+
| Usage | 15,000 API calls |
|
|
57
|
+
| **Total** | 15,000 × \$0.01 = **\$150** |
|
|
46
58
|
|
|
47
59
|
<img height="400" src="/images/flat-pricing.png" />
|
|
48
60
|
|
|
@@ -50,7 +62,20 @@ Customers pay a fixed rate for each unit used. For example you charge \$0.10 per
|
|
|
50
62
|
|
|
51
63
|
#### Package
|
|
52
64
|
|
|
53
|
-
|
|
65
|
+
Instead of charging for every unit individually you sell usage in predefined packages. When a customer exceeds one package they are charged for the next full package, even if they only use part of it.
|
|
66
|
+
|
|
67
|
+
**Best for** Products that want simple pricing, predictable billing increments, and a minimum charge for reserved usage.
|
|
68
|
+
|
|
69
|
+
**Example** An AI image generator selling images in packages of 100.
|
|
70
|
+
|
|
71
|
+
**Sample calculation**
|
|
72
|
+
|
|
73
|
+
| | |
|
|
74
|
+
| --- | --- |
|
|
75
|
+
| Package | 100 images for \$10 |
|
|
76
|
+
| Usage | 205 images |
|
|
77
|
+
| Packages required | 3 |
|
|
78
|
+
| **Total** | 3 × \$10 = **\$30** |
|
|
54
79
|
|
|
55
80
|
<img height="400" src="/images/package-pricing.png" />
|
|
56
81
|
|
|
@@ -58,7 +83,28 @@ Customers buy usage units in predefined bundles. For example you charge \$5.00 f
|
|
|
58
83
|
|
|
59
84
|
#### Tiered
|
|
60
85
|
|
|
61
|
-
|
|
86
|
+
Units are filled into pricing buckets. As usage increases it moves into cheaper brackets, while units in earlier brackets remain charged at their original rate.
|
|
87
|
+
|
|
88
|
+
**Why it's useful** Encourages higher adoption while helping you cover fixed costs for lower-volume users. Especially useful for developer platforms.
|
|
89
|
+
|
|
90
|
+
**Example** An LLM wrapper platform charging based on token usage.
|
|
91
|
+
|
|
92
|
+
**Sample calculation**
|
|
93
|
+
|
|
94
|
+
| Tier | Rate |
|
|
95
|
+
| --- | --- |
|
|
96
|
+
| First 1,000 tokens | \$0.10 / token |
|
|
97
|
+
| Next 4,000 tokens | \$0.05 / token |
|
|
98
|
+
|
|
99
|
+
A customer uses 3,500 tokens.
|
|
100
|
+
|
|
101
|
+
| | |
|
|
102
|
+
| --- | --- |
|
|
103
|
+
| Tier 1 | 1,000 × \$0.10 = \$100 |
|
|
104
|
+
| Tier 2 | 2,500 × \$0.05 = \$125 |
|
|
105
|
+
| **Total** | \$100 + \$125 = **\$225** |
|
|
106
|
+
|
|
107
|
+
Kelviq tracks each pricing bracket automatically, with sub-100ms real-time access checks.
|
|
62
108
|
|
|
63
109
|
<img height="400" src="/images/tiered-pricing.png" />
|
|
64
110
|
|
|
@@ -66,7 +112,27 @@ Unit price decreases progressively as usage crosses defined thresholds. You fill
|
|
|
66
112
|
|
|
67
113
|
#### Volume
|
|
68
114
|
|
|
69
|
-
|
|
115
|
+
Similar to tiered pricing, but with one major difference. Once usage reaches a specific threshold, every unit consumed during that billing cycle is charged at the new rate.
|
|
116
|
+
|
|
117
|
+
**Why it's useful** Creates a strong incentive for high-volume customers to expand their usage by rewarding them with a lower rate across their entire bill.
|
|
118
|
+
|
|
119
|
+
**Example** An API platform charging based on the number of requests processed.
|
|
120
|
+
|
|
121
|
+
**Sample calculation**
|
|
122
|
+
|
|
123
|
+
| Volume | Rate |
|
|
124
|
+
| --- | --- |
|
|
125
|
+
| 1 to 100,000 API calls | \$0.01 / call |
|
|
126
|
+
| 100,001+ API calls | \$0.007 / call (applies to all calls) |
|
|
127
|
+
|
|
128
|
+
A customer makes 120,000 API calls.
|
|
129
|
+
|
|
130
|
+
| | |
|
|
131
|
+
| --- | --- |
|
|
132
|
+
| **Total** | 120,000 × \$0.007 = **\$840** |
|
|
133
|
+
| Without the volume discount | 120,000 × \$0.01 = \$1,200 |
|
|
134
|
+
|
|
135
|
+
Kelviq automatically applies the correct rate when customers cross a volume threshold, with no custom billing logic required.
|
|
70
136
|
|
|
71
137
|
<img height="400" src="/images/volume-pricing.png" />
|
|
72
138
|
|
|
@@ -74,7 +140,22 @@ All units are billed at the rate for the highest usage tier reached. Using the s
|
|
|
74
140
|
|
|
75
141
|
#### Stair-step
|
|
76
142
|
|
|
77
|
-
Customers pay a fixed
|
|
143
|
+
Customers pay a fixed fee based on the usage bracket they fall into, regardless of the exact number of units used within that bracket. There is no per-unit rate.
|
|
144
|
+
|
|
145
|
+
**Why it's useful** Combines the simplicity of subscription plans with the flexibility of usage-based scaling. Perfect for API plans, infrastructure products, and other services with clear usage bands.
|
|
146
|
+
|
|
147
|
+
**Example** An email delivery platform charging based on monthly email volume.
|
|
148
|
+
|
|
149
|
+
**Sample calculation**
|
|
150
|
+
|
|
151
|
+
| Step | Price |
|
|
152
|
+
| --- | --- |
|
|
153
|
+
| Up to 10,000 emails | Flat \$50 |
|
|
154
|
+
| 10,001 to 50,000 emails | Flat \$150 |
|
|
155
|
+
|
|
156
|
+
A customer sends 12,000 emails. They fall into the second step and pay a flat **\$150**.
|
|
157
|
+
|
|
158
|
+
Kelviq automatically moves customers into the correct pricing step as their usage grows, with no custom billing logic required.
|
|
78
159
|
|
|
79
160
|
<img height="400" src="/images/stair-step-pricing.png" />
|
|
80
161
|
|
|
@@ -86,8 +167,6 @@ Once you pick a pricing model you define the exact boundaries.
|
|
|
86
167
|
|
|
87
168
|
If you select Tiered you specify the first unit and last unit for each bucket. You can charge a per unit price and a flat fee within that same tier.
|
|
88
169
|
|
|
89
|
-
When you configure prices across multiple intervals Kelviq can automatically prefill a 20 percent yearly discount for you to edit.
|
|
90
|
-
|
|
91
170
|
You can also set localized pricing for usage based billing. This lets you define different per unit rates for specific countries and currencies.
|
|
92
171
|
|
|
93
172
|
### 5. Set the usage reset cadence
|
|
@@ -37,7 +37,7 @@ From the plan page, click the **Price** section to configure pricing:
|
|
|
37
37
|
|
|
38
38
|
### Usage based pricing
|
|
39
39
|
|
|
40
|
-
To charger your users based on
|
|
40
|
+
To charger your users based on consumption like compute or agent runs you can add usage based pricing.
|
|
41
41
|
|
|
42
42
|
1. In the Price section select the usage billing option
|
|
43
43
|
2. Choose the specific feature you want to track like AI tokens or workflow executions
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
function setupProductText(productName, planName) {
|
|
3
|
+
const productLabel = productName ? `named '${productName}'` : 'for the new offering';
|
|
4
|
+
const planLabel = planName ? `named '${planName}'` : 'for it';
|
|
5
|
+
return [
|
|
6
|
+
`Set up a sellable product ${productLabel} end-to-end, in order:`,
|
|
7
|
+
'',
|
|
8
|
+
`1. Create the product with \`product_create\`. Required fields: \`name\` and \`taxCode\`. If the tax code is not known, ask the user — valid values include \`saas\`, \`saas_business\`, \`software\`, \`ebook\`, \`videocontent\`, \`videogame\`, \`informationservice\`, \`digitalgraphic\`, \`eservice\`, and \`training\`. The response includes the product's UUID — keep it for the next steps.`,
|
|
9
|
+
'',
|
|
10
|
+
'2. For each feature the product should gate, create it with `feature_create`. Choose `featureType`: `BOOLEAN` for a simple on/off flag, `CUSTOMIZABLE` for a configurable quantity (e.g. seats), or `METER` for usage-tracked consumption (e.g. API calls). Each response includes the feature\'s UUID.',
|
|
11
|
+
'',
|
|
12
|
+
`3. Create the plan ${planLabel} with \`plan_create\`, passing the product **UUID** from step 1 (not its identifier) as \`product\`. The new plan is created in DRAFT state and is not visible or purchasable until it is published — do not tell the user the plan is live yet.`,
|
|
13
|
+
'',
|
|
14
|
+
'4. Attach entitlements with `plan_entitlements_add`, referencing each feature by its **UUID** from step 2 (not its identifier), e.g. `planEntitlements: [{ feature: <uuid>, details: {...} }]`. The `details` shape depends on the feature\'s type.',
|
|
15
|
+
'',
|
|
16
|
+
'5. Prices are not set through this MCP server — it has no price-writing tool. Direct the user to set prices for the plan in the Kelviq dashboard, or with the Kelviq CLI\'s pricing-as-code push flow (`kelviq push`). Do not attempt to write prices yourself; once prices exist, `plan_prices_list` can read them back to confirm.',
|
|
17
|
+
'',
|
|
18
|
+
'6. Publish the plan with `plan_publish` to make it live. This is the step that actually exposes the plan (and its DRAFT-only entitlements from step 4) to customers.',
|
|
19
|
+
'',
|
|
20
|
+
'7. Verify the result: `plan_retrieve` to confirm the plan is published, `plan_prices_list` to confirm prices were set (in the dashboard or via the CLI), and `offering_get_product` (by product UUID) to see the public pricing view a customer would see.',
|
|
21
|
+
'',
|
|
22
|
+
'Summarize what was created (product UUID, feature UUIDs, plan identifier) and remind the user to set prices in the dashboard or via `kelviq push` if step 5 has not happened yet.',
|
|
23
|
+
].join('\n');
|
|
24
|
+
}
|
|
25
|
+
function launchPlanText(productId, planName) {
|
|
26
|
+
const productLabel = productId ? `product \`${productId}\`` : 'the target product';
|
|
27
|
+
const planLabel = planName ? `named '${planName}'` : 'for it';
|
|
28
|
+
return [
|
|
29
|
+
`Launch a new plan ${planLabel} on an existing product, in order:`,
|
|
30
|
+
'',
|
|
31
|
+
`1. Confirm the product exists with \`product_retrieve\` for ${productLabel}, and note its UUID.`,
|
|
32
|
+
'',
|
|
33
|
+
'2. List the features already defined on the account with `feature_list` — reuse existing features rather than creating duplicates; note the UUIDs of the ones this plan needs.',
|
|
34
|
+
'',
|
|
35
|
+
"3. Create the plan with `plan_create`, passing the product **UUID** (not its identifier) as `product`. The new plan is created in DRAFT state and is not visible or purchasable until it is published.",
|
|
36
|
+
'',
|
|
37
|
+
'4. Attach entitlements with `plan_entitlements_add`, referencing each feature by its **UUID** from step 2, e.g. `planEntitlements: [{ feature: <uuid>, details: {...} }]`.',
|
|
38
|
+
'',
|
|
39
|
+
"5. Prices are not set through this MCP server — it has no price-writing tool. Direct the user to set prices in the Kelviq dashboard, or with the Kelviq CLI's pricing-as-code push flow (`kelviq push`); `plan_prices_list` can read them back afterward.",
|
|
40
|
+
'',
|
|
41
|
+
'6. Publish the plan with `plan_publish` to make it live. If this plan is replacing an already-published plan and you instead used `plan_update` on it, remember that patching a published (`is_latest`) plan creates a **new draft** — you must call `plan_publish` again to release that new draft; the previous version stays live until you do.',
|
|
42
|
+
'',
|
|
43
|
+
'7. Verify with `plan_retrieve`, `plan_prices_list`, `plan_entitlements_list`, and `offering_get_product` (by product UUID) to confirm the plan is live with the right entitlements and pricing.',
|
|
44
|
+
].join('\n');
|
|
45
|
+
}
|
|
46
|
+
function diagnoseCustomerText(customerId) {
|
|
47
|
+
return [
|
|
48
|
+
`Diagnose entitlement/subscription issues for customer \`${customerId}\`, in order:`,
|
|
49
|
+
'',
|
|
50
|
+
`1. Call \`entitlements_get\` with \`customerId: "${customerId}"\` (omit \`featureId\` to get every entitlement). For each feature note its \`featureType\`, \`hasAccess\`, \`usageLimit\`, \`currentUsage\`, and \`resetAt\` where present.`,
|
|
51
|
+
'',
|
|
52
|
+
`2. Call \`subscription_list\` filtered by \`customerId: "${customerId}"\` to see the customer's active/past subscriptions, which plan(s) they are on, and their charge period and status.`,
|
|
53
|
+
'',
|
|
54
|
+
"3. Cross-check what the entitlements say against what the plan actually grants: call `plan_entitlements_list` for the customer's plan and compare each feature's configured `details` (limits, reset period, hard limit) to the `usageLimit`/`currentUsage`/`hasAccess` values from step 1. Discrepancies point to a stale entitlement, a missed plan migration, or a usage-reporting bug.",
|
|
55
|
+
'',
|
|
56
|
+
'4. If any concept in the results is unclear (e.g. how `resetPeriod` or `hasUnlimitedUsage` behaves), use `docs_search` to look it up before guessing.',
|
|
57
|
+
'',
|
|
58
|
+
"5. Summarize the findings for the user in plain terms — what access the customer has, what they're missing, and why — and propose concrete next actions where applicable, e.g. `usage_report` (behaviour=SET or DELTA) to correct a wrong usage counter, or `subscription_update` to move the customer to the correct plan/features.",
|
|
59
|
+
].join('\n');
|
|
60
|
+
}
|
|
61
|
+
export function registerPrompts(server) {
|
|
62
|
+
server.registerPrompt('setup_product', {
|
|
63
|
+
title: 'Set up a sellable product end-to-end',
|
|
64
|
+
description: 'Guided workflow: create a product, its features, and a plan with entitlements, then publish. Prices are set in the dashboard or with the Kelviq CLI. Use when starting from nothing.',
|
|
65
|
+
argsSchema: {
|
|
66
|
+
productName: z.string().optional().describe('Display name for the new product.'),
|
|
67
|
+
planName: z.string().optional().describe('Display name for the first plan.'),
|
|
68
|
+
},
|
|
69
|
+
}, ({ productName, planName }) => ({
|
|
70
|
+
messages: [
|
|
71
|
+
{
|
|
72
|
+
role: 'user',
|
|
73
|
+
content: { type: 'text', text: setupProductText(productName, planName) },
|
|
74
|
+
},
|
|
75
|
+
],
|
|
76
|
+
}));
|
|
77
|
+
server.registerPrompt('launch_plan', {
|
|
78
|
+
title: 'Launch a new plan on an existing product',
|
|
79
|
+
description: 'Guided workflow: verify the product, reuse existing features, create a draft plan with entitlements, then publish. Prices are set in the dashboard or with the Kelviq CLI. Use when the product already exists.',
|
|
80
|
+
argsSchema: {
|
|
81
|
+
productId: z.string().optional().describe('UUID or identifier of the existing product.'),
|
|
82
|
+
planName: z.string().optional().describe('Display name for the new plan.'),
|
|
83
|
+
},
|
|
84
|
+
}, ({ productId, planName }) => ({
|
|
85
|
+
messages: [
|
|
86
|
+
{
|
|
87
|
+
role: 'user',
|
|
88
|
+
content: { type: 'text', text: launchPlanText(productId, planName) },
|
|
89
|
+
},
|
|
90
|
+
],
|
|
91
|
+
}));
|
|
92
|
+
server.registerPrompt('diagnose_customer', {
|
|
93
|
+
title: "Diagnose a customer's entitlements and subscription",
|
|
94
|
+
description: "Guided workflow: fetch a customer's entitlements and subscriptions, compare them against the plan's configured entitlements, consult the docs for unfamiliar concepts, and summarize findings with concrete next actions.",
|
|
95
|
+
argsSchema: {
|
|
96
|
+
customerId: z.string().describe('The customer ID to diagnose.'),
|
|
97
|
+
},
|
|
98
|
+
}, ({ customerId }) => ({
|
|
99
|
+
messages: [
|
|
100
|
+
{
|
|
101
|
+
role: 'user',
|
|
102
|
+
content: { type: 'text', text: diagnoseCustomerText(customerId) },
|
|
103
|
+
},
|
|
104
|
+
],
|
|
105
|
+
}));
|
|
106
|
+
}
|
|
107
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/prompts/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,SAAS,gBAAgB,CAAC,WAAoB,EAAE,QAAiB;IAC/D,MAAM,YAAY,GAAG,WAAW,CAAC,CAAC,CAAC,UAAU,WAAW,GAAG,CAAC,CAAC,CAAC,sBAAsB,CAAC;IACrF,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,UAAU,QAAQ,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC;IAE9D,OAAO;QACL,6BAA6B,YAAY,wBAAwB;QACjE,EAAE;QACF,uYAAuY;QACvY,EAAE;QACF,ySAAyS;QACzS,EAAE;QACF,sBAAsB,SAAS,kPAAkP;QACjR,EAAE;QACF,qPAAqP;QACrP,EAAE;QACF,sUAAsU;QACtU,EAAE;QACF,sKAAsK;QACtK,EAAE;QACF,4PAA4P;QAC5P,EAAE;QACF,mLAAmL;KACpL,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAED,SAAS,cAAc,CAAC,SAAkB,EAAE,QAAiB;IAC3D,MAAM,YAAY,GAAG,SAAS,CAAC,CAAC,CAAC,aAAa,SAAS,IAAI,CAAC,CAAC,CAAC,oBAAoB,CAAC;IACnF,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,UAAU,QAAQ,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC;IAE9D,OAAO;QACL,qBAAqB,SAAS,oCAAoC;QAClE,EAAE;QACF,+DAA+D,YAAY,sBAAsB;QACjG,EAAE;QACF,gLAAgL;QAChL,EAAE;QACF,wMAAwM;QACxM,EAAE;QACF,4KAA4K;QAC5K,EAAE;QACF,2PAA2P;QAC3P,EAAE;QACF,oVAAoV;QACpV,EAAE;QACF,iMAAiM;KAClM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAED,SAAS,oBAAoB,CAAC,UAAkB;IAC9C,OAAO;QACL,2DAA2D,UAAU,eAAe;QACpF,EAAE;QACF,oDAAoD,UAAU,+KAA+K;QAC7O,EAAE;QACF,4DAA4D,UAAU,qHAAqH;QAC3L,EAAE;QACF,4XAA4X;QAC5X,EAAE;QACF,uJAAuJ;QACvJ,EAAE;QACF,sUAAsU;KACvU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,MAAiB;IAC/C,MAAM,CAAC,cAAc,CACnB,eAAe,EACf;QACE,KAAK,EAAE,sCAAsC;QAC7C,WAAW,EACT,sLAAsL;QACxL,UAAU,EAAE;YACV,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,mCAAmC,CAAC;YAChF,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,kCAAkC,CAAC;SAC7E;KACF,EACD,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QAC9B,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,CAAC,WAAW,EAAE,QAAQ,CAAC,EAAE;aACzE;SACF;KACF,CAAC,CACH,CAAC;IAEF,MAAM,CAAC,cAAc,CACnB,aAAa,EACb;QACE,KAAK,EAAE,0CAA0C;QACjD,WAAW,EACT,iNAAiN;QACnN,UAAU,EAAE;YACV,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,6CAA6C,CAAC;YACxF,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gCAAgC,CAAC;SAC3E;KACF,EACD,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;QAC5B,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE;aACrE;SACF;KACF,CAAC,CACH,CAAC;IAEF,MAAM,CAAC,cAAc,CACnB,mBAAmB,EACnB;QACE,KAAK,EAAE,qDAAqD;QAC5D,WAAW,EACT,2NAA2N;QAC7N,UAAU,EAAE;YACV,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,8BAA8B,CAAC;SAChE;KACF,EACD,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;QACnB,QAAQ,EAAE;YACR;gBACE,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,CAAC,UAAU,CAAC,EAAE;aAClE;SACF;KACF,CAAC,CACH,CAAC;AACJ,CAAC"}
|
package/dist/schemas/kelviq.d.ts
CHANGED
|
@@ -168,11 +168,20 @@ export declare const CreateCheckoutSession: z.ZodObject<{
|
|
|
168
168
|
ipAddress: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
169
169
|
cancelUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
170
170
|
plansEnabled: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
171
|
+
currencyCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
172
|
+
customAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
173
|
+
taxBehavior: z.ZodOptional<z.ZodNullable<z.ZodEnum<["INCLUSIVE", "EXCLUSIVE"]>>>;
|
|
174
|
+
discountsEnabled: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
175
|
+
lockEmail: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
|
|
176
|
+
defaultBillingCountry: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
177
|
+
discountCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
178
|
+
metadata: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
171
179
|
}, "strip", z.ZodTypeAny, {
|
|
172
180
|
planIdentifier: string;
|
|
173
181
|
successUrl: string;
|
|
174
182
|
chargePeriod: "ONE_TIME" | "MONTHLY" | "YEARLY" | "WEEKLY" | "DAILY" | "THREE_MONTHS" | "SIX_MONTHS";
|
|
175
183
|
customerId?: string | null | undefined;
|
|
184
|
+
metadata?: Record<string, unknown> | null | undefined;
|
|
176
185
|
features?: {
|
|
177
186
|
identifier: string;
|
|
178
187
|
quantity: number;
|
|
@@ -180,11 +189,19 @@ export declare const CreateCheckoutSession: z.ZodObject<{
|
|
|
180
189
|
ipAddress?: string | null | undefined;
|
|
181
190
|
cancelUrl?: string | null | undefined;
|
|
182
191
|
plansEnabled?: string | null | undefined;
|
|
192
|
+
currencyCode?: string | null | undefined;
|
|
193
|
+
customAmount?: number | null | undefined;
|
|
194
|
+
taxBehavior?: "INCLUSIVE" | "EXCLUSIVE" | null | undefined;
|
|
195
|
+
discountsEnabled?: boolean | null | undefined;
|
|
196
|
+
lockEmail?: boolean | null | undefined;
|
|
197
|
+
defaultBillingCountry?: string | null | undefined;
|
|
198
|
+
discountCode?: string | null | undefined;
|
|
183
199
|
}, {
|
|
184
200
|
planIdentifier: string;
|
|
185
201
|
successUrl: string;
|
|
186
202
|
chargePeriod: "ONE_TIME" | "MONTHLY" | "YEARLY" | "WEEKLY" | "DAILY" | "THREE_MONTHS" | "SIX_MONTHS";
|
|
187
203
|
customerId?: string | null | undefined;
|
|
204
|
+
metadata?: Record<string, unknown> | null | undefined;
|
|
188
205
|
features?: {
|
|
189
206
|
identifier: string;
|
|
190
207
|
quantity: number;
|
|
@@ -192,6 +209,13 @@ export declare const CreateCheckoutSession: z.ZodObject<{
|
|
|
192
209
|
ipAddress?: string | null | undefined;
|
|
193
210
|
cancelUrl?: string | null | undefined;
|
|
194
211
|
plansEnabled?: string | null | undefined;
|
|
212
|
+
currencyCode?: string | null | undefined;
|
|
213
|
+
customAmount?: number | null | undefined;
|
|
214
|
+
taxBehavior?: "INCLUSIVE" | "EXCLUSIVE" | null | undefined;
|
|
215
|
+
discountsEnabled?: boolean | null | undefined;
|
|
216
|
+
lockEmail?: boolean | null | undefined;
|
|
217
|
+
defaultBillingCountry?: string | null | undefined;
|
|
218
|
+
discountCode?: string | null | undefined;
|
|
195
219
|
}>;
|
|
196
220
|
export declare const GetEntitlements: z.ZodObject<{
|
|
197
221
|
customerId: z.ZodString;
|
|
@@ -320,6 +344,8 @@ export declare const UpdateSubscription: z.ZodObject<{
|
|
|
320
344
|
quantity: number;
|
|
321
345
|
}>, "many">>>;
|
|
322
346
|
ipAddress: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
347
|
+
trialEnd: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
348
|
+
paymentBehavior: z.ZodOptional<z.ZodNullable<z.ZodEnum<["activate_on_payment"]>>>;
|
|
323
349
|
}, "strip", z.ZodTypeAny, {
|
|
324
350
|
planIdentifier: string;
|
|
325
351
|
chargePeriod: "ONE_TIME" | "MONTHLY" | "YEARLY" | "WEEKLY" | "DAILY" | "THREE_MONTHS" | "SIX_MONTHS";
|
|
@@ -329,6 +355,8 @@ export declare const UpdateSubscription: z.ZodObject<{
|
|
|
329
355
|
quantity: number;
|
|
330
356
|
}[] | null | undefined;
|
|
331
357
|
ipAddress?: string | null | undefined;
|
|
358
|
+
trialEnd?: string | null | undefined;
|
|
359
|
+
paymentBehavior?: "activate_on_payment" | null | undefined;
|
|
332
360
|
}, {
|
|
333
361
|
planIdentifier: string;
|
|
334
362
|
chargePeriod: "ONE_TIME" | "MONTHLY" | "YEARLY" | "WEEKLY" | "DAILY" | "THREE_MONTHS" | "SIX_MONTHS";
|
|
@@ -338,6 +366,8 @@ export declare const UpdateSubscription: z.ZodObject<{
|
|
|
338
366
|
quantity: number;
|
|
339
367
|
}[] | null | undefined;
|
|
340
368
|
ipAddress?: string | null | undefined;
|
|
369
|
+
trialEnd?: string | null | undefined;
|
|
370
|
+
paymentBehavior?: "activate_on_payment" | null | undefined;
|
|
341
371
|
}>;
|
|
342
372
|
export declare const CancelSubscription: z.ZodObject<{
|
|
343
373
|
subscriptionId: z.ZodString;
|
|
@@ -403,10 +433,6 @@ export declare const TaxCode: z.ZodEnum<["saas", "saas_business", "software", "v
|
|
|
403
433
|
export declare const FeatureType: z.ZodEnum<["BOOLEAN", "CUSTOMIZABLE", "METER"]>;
|
|
404
434
|
export declare const ResetPeriod: z.ZodEnum<["NEVER", "EVERY_DAY", "EVERY_MONTH", "EVERY_QUARTER", "EVERY_YEAR"]>;
|
|
405
435
|
export declare const DurationUnit: z.ZodEnum<["DAY", "MONTH", "YEAR"]>;
|
|
406
|
-
export declare const PriceType: z.ZodEnum<["FREE", "PAID", "CUSTOM"]>;
|
|
407
|
-
export declare const PriceModel: z.ZodEnum<["FLAT", "PACKAGE", "TIERED", "VOLUME", "STAIRSTEP"]>;
|
|
408
|
-
export declare const TaxBehavior: z.ZodEnum<["INCLUSIVE", "EXCLUSIVE", "UNSPECIFIED"]>;
|
|
409
|
-
export declare const PaymentType: z.ZodEnum<["ADVANCE_COMMITMENT", "PAY_AS_YOU_GO"]>;
|
|
410
436
|
export declare const ListProducts: z.ZodObject<{
|
|
411
437
|
search: z.ZodOptional<z.ZodString>;
|
|
412
438
|
page: z.ZodOptional<z.ZodNumber>;
|
|
@@ -808,36 +834,6 @@ export declare const PlanDiscardDraft: z.ZodObject<{
|
|
|
808
834
|
}, {
|
|
809
835
|
planIdentifier: string;
|
|
810
836
|
}>;
|
|
811
|
-
/**
|
|
812
|
-
* Plan price payload — kept loose because pricing tiers/models permit many
|
|
813
|
-
* shapes (FLAT/PACKAGE/TIERED/VOLUME/STAIRSTEP) and the docs are the source of
|
|
814
|
-
* truth for the deeply-nested feature-pricing details.
|
|
815
|
-
*/
|
|
816
|
-
export declare const PlanPriceItem: z.ZodObject<{
|
|
817
|
-
priceType: z.ZodEnum<["FREE", "PAID", "CUSTOM"]>;
|
|
818
|
-
currency: z.ZodOptional<z.ZodString>;
|
|
819
|
-
freeTrial: z.ZodOptional<z.ZodBoolean>;
|
|
820
|
-
trialPeriod: z.ZodOptional<z.ZodNumber>;
|
|
821
|
-
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
822
|
-
taxBehavior: z.ZodOptional<z.ZodEnum<["INCLUSIVE", "EXCLUSIVE", "UNSPECIFIED"]>>;
|
|
823
|
-
chargeCatalogPrice: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
|
|
824
|
-
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
825
|
-
priceType: z.ZodEnum<["FREE", "PAID", "CUSTOM"]>;
|
|
826
|
-
currency: z.ZodOptional<z.ZodString>;
|
|
827
|
-
freeTrial: z.ZodOptional<z.ZodBoolean>;
|
|
828
|
-
trialPeriod: z.ZodOptional<z.ZodNumber>;
|
|
829
|
-
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
830
|
-
taxBehavior: z.ZodOptional<z.ZodEnum<["INCLUSIVE", "EXCLUSIVE", "UNSPECIFIED"]>>;
|
|
831
|
-
chargeCatalogPrice: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
|
|
832
|
-
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
833
|
-
priceType: z.ZodEnum<["FREE", "PAID", "CUSTOM"]>;
|
|
834
|
-
currency: z.ZodOptional<z.ZodString>;
|
|
835
|
-
freeTrial: z.ZodOptional<z.ZodBoolean>;
|
|
836
|
-
trialPeriod: z.ZodOptional<z.ZodNumber>;
|
|
837
|
-
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
838
|
-
taxBehavior: z.ZodOptional<z.ZodEnum<["INCLUSIVE", "EXCLUSIVE", "UNSPECIFIED"]>>;
|
|
839
|
-
chargeCatalogPrice: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
|
|
840
|
-
}, z.ZodTypeAny, "passthrough">>;
|
|
841
837
|
export declare const PlanPricesList: z.ZodObject<{
|
|
842
838
|
planIdentifier: z.ZodString;
|
|
843
839
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -845,56 +841,6 @@ export declare const PlanPricesList: z.ZodObject<{
|
|
|
845
841
|
}, {
|
|
846
842
|
planIdentifier: string;
|
|
847
843
|
}>;
|
|
848
|
-
export declare const PlanPricesBulkSet: z.ZodObject<{
|
|
849
|
-
planIdentifier: z.ZodString;
|
|
850
|
-
prices: z.ZodArray<z.ZodObject<{
|
|
851
|
-
priceType: z.ZodEnum<["FREE", "PAID", "CUSTOM"]>;
|
|
852
|
-
currency: z.ZodOptional<z.ZodString>;
|
|
853
|
-
freeTrial: z.ZodOptional<z.ZodBoolean>;
|
|
854
|
-
trialPeriod: z.ZodOptional<z.ZodNumber>;
|
|
855
|
-
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
856
|
-
taxBehavior: z.ZodOptional<z.ZodEnum<["INCLUSIVE", "EXCLUSIVE", "UNSPECIFIED"]>>;
|
|
857
|
-
chargeCatalogPrice: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
|
|
858
|
-
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
859
|
-
priceType: z.ZodEnum<["FREE", "PAID", "CUSTOM"]>;
|
|
860
|
-
currency: z.ZodOptional<z.ZodString>;
|
|
861
|
-
freeTrial: z.ZodOptional<z.ZodBoolean>;
|
|
862
|
-
trialPeriod: z.ZodOptional<z.ZodNumber>;
|
|
863
|
-
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
864
|
-
taxBehavior: z.ZodOptional<z.ZodEnum<["INCLUSIVE", "EXCLUSIVE", "UNSPECIFIED"]>>;
|
|
865
|
-
chargeCatalogPrice: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
|
|
866
|
-
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
867
|
-
priceType: z.ZodEnum<["FREE", "PAID", "CUSTOM"]>;
|
|
868
|
-
currency: z.ZodOptional<z.ZodString>;
|
|
869
|
-
freeTrial: z.ZodOptional<z.ZodBoolean>;
|
|
870
|
-
trialPeriod: z.ZodOptional<z.ZodNumber>;
|
|
871
|
-
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
872
|
-
taxBehavior: z.ZodOptional<z.ZodEnum<["INCLUSIVE", "EXCLUSIVE", "UNSPECIFIED"]>>;
|
|
873
|
-
chargeCatalogPrice: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
|
|
874
|
-
}, z.ZodTypeAny, "passthrough">>, "many">;
|
|
875
|
-
}, "strip", z.ZodTypeAny, {
|
|
876
|
-
planIdentifier: string;
|
|
877
|
-
prices: z.objectOutputType<{
|
|
878
|
-
priceType: z.ZodEnum<["FREE", "PAID", "CUSTOM"]>;
|
|
879
|
-
currency: z.ZodOptional<z.ZodString>;
|
|
880
|
-
freeTrial: z.ZodOptional<z.ZodBoolean>;
|
|
881
|
-
trialPeriod: z.ZodOptional<z.ZodNumber>;
|
|
882
|
-
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
883
|
-
taxBehavior: z.ZodOptional<z.ZodEnum<["INCLUSIVE", "EXCLUSIVE", "UNSPECIFIED"]>>;
|
|
884
|
-
chargeCatalogPrice: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
|
|
885
|
-
}, z.ZodTypeAny, "passthrough">[];
|
|
886
|
-
}, {
|
|
887
|
-
planIdentifier: string;
|
|
888
|
-
prices: z.objectInputType<{
|
|
889
|
-
priceType: z.ZodEnum<["FREE", "PAID", "CUSTOM"]>;
|
|
890
|
-
currency: z.ZodOptional<z.ZodString>;
|
|
891
|
-
freeTrial: z.ZodOptional<z.ZodBoolean>;
|
|
892
|
-
trialPeriod: z.ZodOptional<z.ZodNumber>;
|
|
893
|
-
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
894
|
-
taxBehavior: z.ZodOptional<z.ZodEnum<["INCLUSIVE", "EXCLUSIVE", "UNSPECIFIED"]>>;
|
|
895
|
-
chargeCatalogPrice: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>, "many">>;
|
|
896
|
-
}, z.ZodTypeAny, "passthrough">[];
|
|
897
|
-
}>;
|
|
898
844
|
/**
|
|
899
845
|
* Per-feature entitlement on a plan. The exact shape varies by feature_type;
|
|
900
846
|
* passthrough lets the caller supply additional keys not enumerated here.
|
|
@@ -1258,47 +1204,3 @@ export declare const PlanFileDownload: z.ZodObject<{
|
|
|
1258
1204
|
planIdentifier: string;
|
|
1259
1205
|
fileId: string;
|
|
1260
1206
|
}>;
|
|
1261
|
-
export declare const MediaPresignedUpload: z.ZodObject<{
|
|
1262
|
-
fileName: z.ZodString;
|
|
1263
|
-
fileType: z.ZodString;
|
|
1264
|
-
}, "strip", z.ZodTypeAny, {
|
|
1265
|
-
fileName: string;
|
|
1266
|
-
fileType: string;
|
|
1267
|
-
}, {
|
|
1268
|
-
fileName: string;
|
|
1269
|
-
fileType: string;
|
|
1270
|
-
}>;
|
|
1271
|
-
export declare const PartnerOrgProvision: z.ZodObject<{
|
|
1272
|
-
externalId: z.ZodString;
|
|
1273
|
-
email: z.ZodString;
|
|
1274
|
-
businessName: z.ZodOptional<z.ZodString>;
|
|
1275
|
-
}, "strip", z.ZodTypeAny, {
|
|
1276
|
-
email: string;
|
|
1277
|
-
externalId: string;
|
|
1278
|
-
businessName?: string | undefined;
|
|
1279
|
-
}, {
|
|
1280
|
-
email: string;
|
|
1281
|
-
externalId: string;
|
|
1282
|
-
businessName?: string | undefined;
|
|
1283
|
-
}>;
|
|
1284
|
-
export declare const PartnerOrgList: z.ZodObject<{
|
|
1285
|
-
externalId: z.ZodOptional<z.ZodString>;
|
|
1286
|
-
}, "strip", z.ZodTypeAny, {
|
|
1287
|
-
externalId?: string | undefined;
|
|
1288
|
-
}, {
|
|
1289
|
-
externalId?: string | undefined;
|
|
1290
|
-
}>;
|
|
1291
|
-
export declare const PartnerOrgRetrieve: z.ZodObject<{
|
|
1292
|
-
identifier: z.ZodString;
|
|
1293
|
-
}, "strip", z.ZodTypeAny, {
|
|
1294
|
-
identifier: string;
|
|
1295
|
-
}, {
|
|
1296
|
-
identifier: string;
|
|
1297
|
-
}>;
|
|
1298
|
-
export declare const PartnerOrgRetrieveByExternalId: z.ZodObject<{
|
|
1299
|
-
externalId: z.ZodString;
|
|
1300
|
-
}, "strip", z.ZodTypeAny, {
|
|
1301
|
-
externalId: string;
|
|
1302
|
-
}, {
|
|
1303
|
-
externalId: string;
|
|
1304
|
-
}>;
|
package/dist/schemas/kelviq.js
CHANGED
|
@@ -77,6 +77,46 @@ export const CreateCheckoutSession = z.object({
|
|
|
77
77
|
.nullable()
|
|
78
78
|
.optional()
|
|
79
79
|
.describe('Comma-separated plan identifiers to show on the checkout page.'),
|
|
80
|
+
currencyCode: z
|
|
81
|
+
.string()
|
|
82
|
+
.nullable()
|
|
83
|
+
.optional()
|
|
84
|
+
.describe('Currency code, e.g. "USD". Required when customAmount is set with a server API key.'),
|
|
85
|
+
customAmount: z
|
|
86
|
+
.number()
|
|
87
|
+
.nullable()
|
|
88
|
+
.optional()
|
|
89
|
+
.describe('Custom amount to charge for this session (e.g. 2999). When set, taxBehavior is required; with a server key, currencyCode is also required.'),
|
|
90
|
+
taxBehavior: z
|
|
91
|
+
.enum(['INCLUSIVE', 'EXCLUSIVE'])
|
|
92
|
+
.nullable()
|
|
93
|
+
.optional()
|
|
94
|
+
.describe('How tax applies to customAmount. INCLUSIVE = tax included in the amount; EXCLUSIVE = added on top. Required when customAmount is set.'),
|
|
95
|
+
discountsEnabled: z
|
|
96
|
+
.boolean()
|
|
97
|
+
.nullable()
|
|
98
|
+
.optional()
|
|
99
|
+
.describe('Show coupon/discount entry on the checkout page. Defaults to true.'),
|
|
100
|
+
lockEmail: z
|
|
101
|
+
.boolean()
|
|
102
|
+
.nullable()
|
|
103
|
+
.optional()
|
|
104
|
+
.describe('Pre-fill and lock the email field so the customer cannot change it. Defaults to false.'),
|
|
105
|
+
defaultBillingCountry: z
|
|
106
|
+
.string()
|
|
107
|
+
.nullable()
|
|
108
|
+
.optional()
|
|
109
|
+
.describe('ISO 3166-1 alpha-2 country code to pre-fill the billing country.'),
|
|
110
|
+
discountCode: z
|
|
111
|
+
.string()
|
|
112
|
+
.nullable()
|
|
113
|
+
.optional()
|
|
114
|
+
.describe('Discount/coupon code to pre-apply to the checkout session. Applied only if active, unexpired, and valid for the selected plan; otherwise the request fails.'),
|
|
115
|
+
metadata: z
|
|
116
|
+
.record(z.unknown())
|
|
117
|
+
.nullable()
|
|
118
|
+
.optional()
|
|
119
|
+
.describe('Arbitrary key-value pairs to attach to the session; returned unchanged on the checkout.completed webhook payload.'),
|
|
80
120
|
});
|
|
81
121
|
// -- Entitlements ---------------------------------------------------------
|
|
82
122
|
export const GetEntitlements = z.object({
|
|
@@ -134,6 +174,16 @@ export const UpdateSubscription = z.object({
|
|
|
134
174
|
chargePeriod: ChargePeriod,
|
|
135
175
|
features: z.array(FeatureInput).nullable().optional(),
|
|
136
176
|
ipAddress: z.string().nullable().optional(),
|
|
177
|
+
trialEnd: z
|
|
178
|
+
.string()
|
|
179
|
+
.nullable()
|
|
180
|
+
.optional()
|
|
181
|
+
.describe('Trial control: the literal "now" ends any active trial immediately, or an ISO 8601 datetime (e.g. "2027-12-31 23:59:59") sets a new trial end date.'),
|
|
182
|
+
paymentBehavior: z
|
|
183
|
+
.enum(['activate_on_payment'])
|
|
184
|
+
.nullable()
|
|
185
|
+
.optional()
|
|
186
|
+
.describe('Set to "activate_on_payment" to keep the current subscription active while payment is pending and apply the new plan/charge period/features only after payment succeeds.'),
|
|
137
187
|
});
|
|
138
188
|
export const CancelSubscription = z.object({
|
|
139
189
|
subscriptionId: z.string().uuid().describe('UUID of the subscription to cancel (path parameter).'),
|
|
@@ -202,10 +252,6 @@ export const ResetPeriod = z.enum([
|
|
|
202
252
|
'EVERY_YEAR',
|
|
203
253
|
]);
|
|
204
254
|
export const DurationUnit = z.enum(['DAY', 'MONTH', 'YEAR']);
|
|
205
|
-
export const PriceType = z.enum(['FREE', 'PAID', 'CUSTOM']);
|
|
206
|
-
export const PriceModel = z.enum(['FLAT', 'PACKAGE', 'TIERED', 'VOLUME', 'STAIRSTEP']);
|
|
207
|
-
export const TaxBehavior = z.enum(['INCLUSIVE', 'EXCLUSIVE', 'UNSPECIFIED']);
|
|
208
|
-
export const PaymentType = z.enum(['ADVANCE_COMMITMENT', 'PAY_AS_YOU_GO']);
|
|
209
255
|
// -- Products -------------------------------------------------------------
|
|
210
256
|
export const ListProducts = z.object({
|
|
211
257
|
search: z.string().optional().describe('Filter by name/identifier substring.'),
|
|
@@ -342,34 +388,9 @@ export const PlanDiscardDraft = z.object({
|
|
|
342
388
|
planIdentifier: z.string().describe('Plan identifier whose draft should be discarded.'),
|
|
343
389
|
});
|
|
344
390
|
// -- Plan Prices ----------------------------------------------------------
|
|
345
|
-
/**
|
|
346
|
-
* Plan price payload — kept loose because pricing tiers/models permit many
|
|
347
|
-
* shapes (FLAT/PACKAGE/TIERED/VOLUME/STAIRSTEP) and the docs are the source of
|
|
348
|
-
* truth for the deeply-nested feature-pricing details.
|
|
349
|
-
*/
|
|
350
|
-
export const PlanPriceItem = z
|
|
351
|
-
.object({
|
|
352
|
-
priceType: PriceType,
|
|
353
|
-
currency: z.string().optional(),
|
|
354
|
-
freeTrial: z.boolean().optional(),
|
|
355
|
-
trialPeriod: z.number().int().optional(),
|
|
356
|
-
enabled: z.boolean().optional(),
|
|
357
|
-
taxBehavior: TaxBehavior.optional(),
|
|
358
|
-
chargeCatalogPrice: z
|
|
359
|
-
.array(z.record(z.unknown()))
|
|
360
|
-
.optional()
|
|
361
|
-
.describe('Array of `{feature?, priceModel, paymentType, charges, …}`. See docs page api-reference/plans/update-plan-prices for the full per-charge shape.'),
|
|
362
|
-
})
|
|
363
|
-
.passthrough();
|
|
364
391
|
export const PlanPricesList = z.object({
|
|
365
392
|
planIdentifier: z.string().describe('Plan identifier.'),
|
|
366
393
|
});
|
|
367
|
-
export const PlanPricesBulkSet = z.object({
|
|
368
|
-
planIdentifier: z.string().describe('Plan identifier.'),
|
|
369
|
-
prices: z
|
|
370
|
-
.array(PlanPriceItem)
|
|
371
|
-
.describe('Replaces all prices on the plan atomically. Cannot include multiple PAID prices for the same currency.'),
|
|
372
|
-
});
|
|
373
394
|
// -- Plan Entitlements ----------------------------------------------------
|
|
374
395
|
/**
|
|
375
396
|
* Per-feature entitlement on a plan. The exact shape varies by feature_type;
|
|
@@ -431,38 +452,4 @@ export const PlanFileDownload = z.object({
|
|
|
431
452
|
planIdentifier: z.string().describe('Plan identifier.'),
|
|
432
453
|
fileId: z.string().describe('File UUID.'),
|
|
433
454
|
});
|
|
434
|
-
// -- Media ----------------------------------------------------------------
|
|
435
|
-
export const MediaPresignedUpload = z.object({
|
|
436
|
-
fileName: z
|
|
437
|
-
.string()
|
|
438
|
-
.describe('Filename, used as the suffix of the returned S3 object key.'),
|
|
439
|
-
fileType: z
|
|
440
|
-
.string()
|
|
441
|
-
.describe('MIME type. Enforced by the presigned policy at upload time.'),
|
|
442
|
-
});
|
|
443
|
-
// -- Partner --------------------------------------------------------------
|
|
444
|
-
export const PartnerOrgProvision = z.object({
|
|
445
|
-
externalId: z
|
|
446
|
-
.string()
|
|
447
|
-
.max(128)
|
|
448
|
-
.describe('Your partner-side identifier for this org. Must be unique within your partner.'),
|
|
449
|
-
email: z.string().email().describe('Email of the new organization owner. Must not match an existing user.'),
|
|
450
|
-
businessName: z
|
|
451
|
-
.string()
|
|
452
|
-
.max(200)
|
|
453
|
-
.optional()
|
|
454
|
-
.describe('Optional org name; sets org name + slug when provided.'),
|
|
455
|
-
});
|
|
456
|
-
export const PartnerOrgList = z.object({
|
|
457
|
-
externalId: z
|
|
458
|
-
.string()
|
|
459
|
-
.optional()
|
|
460
|
-
.describe('Optional. Filter by your partner-side identifier.'),
|
|
461
|
-
});
|
|
462
|
-
export const PartnerOrgRetrieve = z.object({
|
|
463
|
-
identifier: z.string().describe('Kelviq-side identifier of the partner organization.'),
|
|
464
|
-
});
|
|
465
|
-
export const PartnerOrgRetrieveByExternalId = z.object({
|
|
466
|
-
externalId: z.string().describe('Your partner-side identifier.'),
|
|
467
|
-
});
|
|
468
455
|
//# sourceMappingURL=kelviq.js.map
|