@kelviq/mcp-server 1.2.1 → 1.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.
- package/README.md +40 -3
- package/dist/config.d.ts +5 -0
- package/dist/config.js +1 -0
- package/dist/config.js.map +1 -1
- package/dist/docs/ai/docs-for-agents.md +21 -0
- package/dist/docs/ai/overview.md +43 -0
- package/dist/docs/api-reference/authentication.md +9 -3
- package/dist/docs/api-reference/introduction.md +23 -2
- package/dist/docs/backend-integration/node-sdk.md +12 -6
- package/dist/docs/backend-integration/python-sdk.md +14 -8
- package/dist/docs/changelog.md +352 -3
- package/dist/docs/checkout/checkout-configuration.md +25 -75
- package/dist/docs/checkout/checkout-design.md +76 -0
- package/dist/docs/checkout/checkout-examples.md +212 -0
- package/dist/docs/checkout/checkout-metadata.md +1 -1
- package/dist/docs/checkout/custom-fields.md +60 -0
- package/dist/docs/checkout/embed-checkout.md +280 -0
- package/dist/docs/checkout/payment-methods/upi.md +69 -0
- package/dist/docs/checkout/payment-methods.md +119 -0
- package/dist/docs/checkout/static-checkout-url.md +3 -2
- package/dist/docs/cli/commands.md +57 -4
- package/dist/docs/cli/kelviq-config.md +1 -1
- package/dist/docs/cli/overview.md +1 -0
- package/dist/docs/customer-portal/managing-payment-methods.md +4 -4
- package/dist/docs/customer-portal/overview.md +7 -7
- package/dist/docs/customer-portal/retention.md +109 -0
- package/dist/docs/customers-management/overview.md +105 -0
- package/dist/docs/frontend-integration/js-sdk.md +11 -11
- package/dist/docs/frontend-integration/promotions-ui-js.md +2 -2
- package/dist/docs/frontend-integration/react-sdk.md +8 -49
- package/dist/docs/frontend-integration/react-ui.md +8 -6
- package/dist/docs/getstarted/fees.md +27 -11
- package/dist/docs/getstarted/introduction-to-kelviq.md +29 -66
- package/dist/docs/getstarted/merchant-of-record.md +18 -24
- package/dist/docs/getstarted/overview.md +98 -0
- package/dist/docs/getstarted/review-process.md +59 -59
- package/dist/docs/guides/agent-toolkit.md +14 -9
- package/dist/docs/guides/mcp-server.md +24 -9
- package/dist/docs/guides/migrate-from-lemon-squeezy.md +405 -0
- package/dist/docs/guides/sandbox.md +6 -4
- package/dist/docs/guides/set-up-with-ai.md +43 -0
- package/dist/docs/guides/subscription-integration-for-nextjs.md +10 -11
- package/dist/docs/guides/subscription-integration.md +1 -1
- package/dist/docs/guides/test-payments.md +640 -0
- package/dist/docs/guides/webhooks.md +182 -30
- package/dist/docs/integrations/woocommerce.md +88 -0
- package/dist/docs/integrations/zapier.md +22 -0
- package/dist/docs/legal/account-and-funds.md +59 -0
- package/dist/docs/legal/approved-prohibited-policy.md +32 -27
- package/dist/docs/legal/payment-flow-diagram.md +7 -7
- package/dist/docs/manifest.json +160 -41
- package/dist/docs/openapi.json +1359 -109
- package/dist/docs/payouts/overview.md +14 -12
- package/dist/docs/payouts/payout-account.md +1 -1
- package/dist/docs/payouts/transactions.md +3 -3
- package/dist/docs/product-catalog/create-a-feature.md +3 -3
- package/dist/docs/product-catalog/digital-downloads.md +5 -5
- package/dist/docs/product-catalog/discounts.md +2 -2
- package/dist/docs/product-catalog/entitlements.md +20 -27
- package/dist/docs/product-catalog/free-and-trials.md +4 -4
- package/dist/docs/product-catalog/license-keys.md +56 -29
- package/dist/docs/product-catalog/links.md +3 -3
- package/dist/docs/product-catalog/location-based-pricing.md +6 -10
- package/dist/docs/product-catalog/one-time-payments.md +3 -7
- package/dist/docs/product-catalog/pay-as-you-go.md +8 -8
- package/dist/docs/product-catalog/plans.md +22 -19
- package/dist/docs/product-catalog/products.md +11 -3
- package/dist/docs/product-catalog/proration.md +69 -0
- package/dist/docs/product-catalog/seat-based-pricing.md +7 -7
- package/dist/docs/product-catalog/subscriptions.md +52 -22
- package/dist/docs/product-catalog/tax-settings.md +8 -8
- package/dist/docs/product-catalog/usage-alerts.md +7 -7
- package/dist/docs/product-catalog/usage-based-billing.md +156 -29
- package/dist/docs/product-catalog/usage-limits.md +78 -0
- package/dist/docs/promotions/create-a-promotion.md +2 -2
- package/dist/docs/promotions/overview.md +1 -1
- package/dist/docs/quickstart/core-concepts.md +36 -30
- package/dist/docs/quickstart/dashboard-setup.md +26 -22
- package/dist/docs/quickstart/integrate-with-your-app.md +133 -52
- package/dist/docs/sales/abandoned-cart-recovery.md +7 -3
- package/dist/docs/sales/checkout-sessions.md +28 -39
- package/dist/docs/sales/orders.md +30 -54
- package/dist/docs/settings/customer-emails.md +52 -0
- package/dist/docs/settings/members.md +27 -0
- package/dist/docs/settings/profile.md +26 -0
- package/dist/docs/settings/zapier.md +22 -0
- package/dist/http/errors.d.ts +20 -1
- package/dist/http/errors.js +83 -31
- package/dist/http/errors.js.map +1 -1
- package/dist/schemas/kelviq.d.ts +54 -0
- package/dist/schemas/kelviq.js +64 -0
- package/dist/schemas/kelviq.js.map +1 -1
- package/dist/server.js +3 -2
- package/dist/server.js.map +1 -1
- package/dist/tools/imports.d.ts +68 -0
- package/dist/tools/imports.js +242 -0
- package/dist/tools/imports.js.map +1 -0
- package/dist/tools/index.d.ts +2 -1
- package/dist/tools/index.js +4 -1
- package/dist/tools/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,212 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Checkout examples"
|
|
3
|
+
slug: "checkout/checkout-examples"
|
|
4
|
+
section: "checkout"
|
|
5
|
+
description: "See how checkout looks for subscriptions, free plans, trials, one-time payments, usage-based plans, and discounts"
|
|
6
|
+
---
|
|
7
|
+
Every example is a live sandbox checkout. To try one, pay with the test card `4242 4242 4242 4242`, any future expiry date, and any CVC. Other outcomes are in [Test payments](/guides/test-payments).
|
|
8
|
+
|
|
9
|
+
The examples use the default look. You can change the logo, colors, and which sections appear in [Checkout design](/checkout/checkout-design).
|
|
10
|
+
|
|
11
|
+
| Example | What changes at checkout | Button |
|
|
12
|
+
| --- | --- | --- |
|
|
13
|
+
| [Plan picker](#plan-picker) | Customer chooses from several plans | **Subscribe** |
|
|
14
|
+
| [Single plan](#single-plan) | Price shown at the top, no plan list | **Subscribe** |
|
|
15
|
+
| [Free plan](#free-plan) | Name and email only, no payment fields | **Get it for Free** |
|
|
16
|
+
| [Free trial](#free-trial) | Shows the first charge date, nothing due today | **Start 7-day Trial** |
|
|
17
|
+
| [More billing periods](#more-billing-periods) | Extra tabs for 3 and 6 months | **Subscribe** |
|
|
18
|
+
| [One-time payment](#one-time-payment) | No billing period, one charge | **Pay Now** |
|
|
19
|
+
| [Included usage with overage](#included-usage-with-overage) | Base fee today, overage billed later | **Subscribe** |
|
|
20
|
+
| [Pay as you go](#pay-as-you-go) | \$0 today, usage billed monthly | **Subscribe** |
|
|
21
|
+
| [Prepaid credit pack](#prepaid-credit-pack) | One-time top-up of usage | **Pay Now** |
|
|
22
|
+
| [Discount applied](#discount-applied) | Code filled in and deducted | **Subscribe** |
|
|
23
|
+
| [Discount field hidden](#discount-field-hidden) | No promotion code entry | **Subscribe** |
|
|
24
|
+
| [Per-seat plan](#per-seat-plan) | Seat count and total for the team | **Start 14-day Trial** |
|
|
25
|
+
| [Prefilled customer](#prefilled-customer) | Name and email already filled in | **Subscribe** |
|
|
26
|
+
| [Business purchase](#business-purchase) | Company name, address, and tax ID fields | **Subscribe** |
|
|
27
|
+
|
|
28
|
+
## Light and dark mode
|
|
29
|
+
|
|
30
|
+
By default, checkout follows the light or dark setting on the customer's device, and the customer can switch it from the bottom-left corner. To always show light or dark, change the mode in [Checkout design](/checkout/checkout-design#default-mode). The other screenshots on this page match the theme you're reading in.
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
<img src="/images/checkout-examples/pricing-table-light.webp" alt="VoiceForge AI checkout in light mode" />
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
<img src="/images/checkout-examples/pricing-table-dark.webp" alt="VoiceForge AI checkout in dark mode" />
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
## Plan picker
|
|
51
|
+
|
|
52
|
+
List several plans in the link and checkout shows them as a list the customer can choose from. You also pick which plan is selected when the page opens. This is the usual link behind a **Buy** button on a pricing page.
|
|
53
|
+
|
|
54
|
+
<img className="block dark:hidden" src="/images/checkout-examples/pricing-table-light.webp" alt="Checkout with five VoiceForge AI plans, Creator selected, Monthly and Yearly tabs" />
|
|
55
|
+
<img className="hidden dark:block" src="/images/checkout-examples/pricing-table-dark.webp" alt="Checkout with five VoiceForge AI plans, Creator selected, Monthly and Yearly tabs" />
|
|
56
|
+
|
|
57
|
+
[See example →](https://www.kelviq.com/sandbox/buy/f60cea73-579b-4932-8d85-02b79710e9dc/?enabled=voice-starter,voice-creator,voice-pro,voice-scale,voice-business&plan_identifier=voice-creator&charge_period=MONTHLY)
|
|
58
|
+
|
|
59
|
+
## Single plan
|
|
60
|
+
|
|
61
|
+
Put only one plan in the link and checkout shows just that plan, already selected. Use this when the customer has picked a plan on your site.
|
|
62
|
+
|
|
63
|
+
<img className="block dark:hidden" src="/images/checkout-examples/single-plan-light.webp" alt="Checkout showing only the VoiceForge AI Starter plan at $6 per month" />
|
|
64
|
+
<img className="hidden dark:block" src="/images/checkout-examples/single-plan-dark.webp" alt="Checkout showing only the VoiceForge AI Starter plan at $6 per month" />
|
|
65
|
+
|
|
66
|
+
[See example →](https://www.kelviq.com/sandbox/buy/f60cea73-579b-4932-8d85-02b79710e9dc/?enabled=voice-starter&plan_identifier=voice-starter&charge_period=MONTHLY)
|
|
67
|
+
|
|
68
|
+
## Free plan
|
|
69
|
+
|
|
70
|
+
A [free plan](/product-catalog/free-and-trials#free-plans) asks for a name and email only. There are no card or address fields, and the button reads **Get it for Free**. The customer still gets a subscription and the plan's entitlements.
|
|
71
|
+
|
|
72
|
+
<img className="block dark:hidden" src="/images/checkout-examples/free-plan-light.webp" alt="Free forever checkout for Context API with name and email fields" />
|
|
73
|
+
<img className="hidden dark:block" src="/images/checkout-examples/free-plan-dark.webp" alt="Free forever checkout for Context API with name and email fields" />
|
|
74
|
+
|
|
75
|
+
[See example →](https://www.kelviq.com/sandbox/buy/574a07ca-b9ef-4700-9907-deb64bd7f7e3/?enabled=ctx-free&plan_identifier=ctx-free&charge_period=MONTHLY)
|
|
76
|
+
|
|
77
|
+
## Free trial
|
|
78
|
+
|
|
79
|
+
When the plan has a [trial period](/product-catalog/free-and-trials), checkout collects the card but charges nothing today. The summary shows **Total after trial** and **Total due today**, and the text under the button gives the date of the first charge.
|
|
80
|
+
|
|
81
|
+
<img className="block dark:hidden" src="/images/checkout-examples/free-trial-light.webp" alt="StudyPal Premium checkout with a Start 7-day Trial button and the first charge date" />
|
|
82
|
+
<img className="hidden dark:block" src="/images/checkout-examples/free-trial-dark.webp" alt="StudyPal Premium checkout with a Start 7-day Trial button and the first charge date" />
|
|
83
|
+
|
|
84
|
+
[See example →](https://www.kelviq.com/sandbox/buy/dfb9c6d9-d195-4176-8bf3-036e42345c3d/?enabled=sp-premium&plan_identifier=sp-premium&charge_period=MONTHLY)
|
|
85
|
+
|
|
86
|
+
The trial comes from the plan settings, not from the link.
|
|
87
|
+
|
|
88
|
+
The price is in rupees because this plan uses [location-based pricing](/product-catalog/location-based-pricing) and the screenshot was taken from India.
|
|
89
|
+
|
|
90
|
+
## More billing periods
|
|
91
|
+
|
|
92
|
+
A plan can be sold monthly, every 3 months, every 6 months, and yearly. Checkout shows a tab for each period the plan has a price for, and the link decides which tab opens first.
|
|
93
|
+
|
|
94
|
+
<img className="block dark:hidden" src="/images/checkout-examples/billing-intervals-light.webp" alt="StudyPal checkout with Monthly, Yearly, 3 Months, and 6 Months tabs, 3 Months selected" />
|
|
95
|
+
<img className="hidden dark:block" src="/images/checkout-examples/billing-intervals-dark.webp" alt="StudyPal checkout with Monthly, Yearly, 3 Months, and 6 Months tabs, 3 Months selected" />
|
|
96
|
+
|
|
97
|
+
[See example →](https://www.kelviq.com/sandbox/buy/dfb9c6d9-d195-4176-8bf3-036e42345c3d/?enabled=sp-premium&plan_identifier=sp-premium&charge_period=THREE_MONTHS)
|
|
98
|
+
|
|
99
|
+
## One-time payment
|
|
100
|
+
|
|
101
|
+
For a [one-time](/product-catalog/one-time-payments) plan there's no billing-period toggle, the summary says **One-time payment**, and the button reads **Pay Now**.
|
|
102
|
+
|
|
103
|
+
<img className="block dark:hidden" src="/images/checkout-examples/one-time-light.webp" alt="One-time checkout for the PixelGallery JS Hobby license at $48" />
|
|
104
|
+
<img className="hidden dark:block" src="/images/checkout-examples/one-time-dark.webp" alt="One-time checkout for the PixelGallery JS Hobby license at $48" />
|
|
105
|
+
|
|
106
|
+
[See example →](https://www.kelviq.com/sandbox/buy/83cd7be6-8459-4099-bee7-47bbf74c6813/?enabled=pg-hobby&plan_identifier=pg-hobby&charge_period=ONE_TIME)
|
|
107
|
+
|
|
108
|
+
The PixelGallery plans issue a [license key](/product-catalog/license-keys) with each order. For an ebook or course, attach [digital downloads](/product-catalog/digital-downloads) to the plan instead.
|
|
109
|
+
|
|
110
|
+
You can offer several one-time plans on one page, the same way as subscriptions. This example offers an ebook or a bundle, with the bundle selected:
|
|
111
|
+
|
|
112
|
+
<img className="block dark:hidden" src="/images/checkout-examples/one-time-choice-light.webp" alt="Indie SaaS Playbook checkout with Complete bundle and Ebook options" />
|
|
113
|
+
<img className="hidden dark:block" src="/images/checkout-examples/one-time-choice-dark.webp" alt="Indie SaaS Playbook checkout with Complete bundle and Ebook options" />
|
|
114
|
+
|
|
115
|
+
[See example →](https://www.kelviq.com/sandbox/buy/9b6bc03c-8899-4bfc-b435-fbf7ca855741/?enabled=ip-ebook,ip-complete&plan_identifier=ip-complete&charge_period=ONE_TIME)
|
|
116
|
+
|
|
117
|
+
## Included usage with overage
|
|
118
|
+
|
|
119
|
+
The Context API Developer plan costs \$19 a month, includes 7,500 credits, and charges \$2.20 per 1,000 credits after that. Checkout charges the \$19 base fee. Overage is [billed at the end of each monthly period](/product-catalog/usage-based-billing) from the usage your backend reports.
|
|
120
|
+
|
|
121
|
+
<img className="block dark:hidden" src="/images/checkout-examples/usage-overage-light.webp" alt="Context API Developer checkout at $19 per month with included features" />
|
|
122
|
+
<img className="hidden dark:block" src="/images/checkout-examples/usage-overage-dark.webp" alt="Context API Developer checkout at $19 per month with included features" />
|
|
123
|
+
|
|
124
|
+
[See example →](https://www.kelviq.com/sandbox/buy/574a07ca-b9ef-4700-9907-deb64bd7f7e3/?enabled=ctx-developer&plan_identifier=ctx-developer&charge_period=MONTHLY)
|
|
125
|
+
|
|
126
|
+
## Pay as you go
|
|
127
|
+
|
|
128
|
+
A [pay-as-you-go](/product-catalog/pay-as-you-go) plan with no base price opens at \$0 a month. Nothing is charged at checkout. The token rates are listed under what's included, and Kelviq bills the recorded usage at the end of each month.
|
|
129
|
+
|
|
130
|
+
<img className="block dark:hidden" src="/images/checkout-examples/pay-as-you-go-light.webp" alt="TokenFlow pay as you go checkout at $0 per month" />
|
|
131
|
+
<img className="hidden dark:block" src="/images/checkout-examples/pay-as-you-go-dark.webp" alt="TokenFlow pay as you go checkout at $0 per month" />
|
|
132
|
+
|
|
133
|
+
[See example →](https://www.kelviq.com/sandbox/buy/47236d49-8477-4483-9b8e-a1b35f1886e2/?enabled=tf-payg&plan_identifier=tf-payg&charge_period=MONTHLY)
|
|
134
|
+
|
|
135
|
+
## Prepaid credit pack
|
|
136
|
+
|
|
137
|
+
Sell usage upfront with a one-time plan that grants a fixed amount of a Meter feature. This pack adds 5M tokens for \$10.
|
|
138
|
+
|
|
139
|
+
<img className="block dark:hidden" src="/images/checkout-examples/token-pack-light.webp" alt="TokenFlow one-time checkout for a 5M token pack at $10" />
|
|
140
|
+
<img className="hidden dark:block" src="/images/checkout-examples/token-pack-dark.webp" alt="TokenFlow one-time checkout for a 5M token pack at $10" />
|
|
141
|
+
|
|
142
|
+
[See example →](https://www.kelviq.com/sandbox/buy/47236d49-8477-4483-9b8e-a1b35f1886e2/?enabled=tf-pack-10&plan_identifier=tf-pack-10&charge_period=ONE_TIME)
|
|
143
|
+
|
|
144
|
+
## Discount applied
|
|
145
|
+
|
|
146
|
+
A link can carry a discount code, so the customer doesn't have to type it. Checkout fills in the code and shows the discount and the reduced total. Here the link adds `discount_code=VOICE50`, which takes 50% off the first month of Creator. Use it in campaign emails and partner links.
|
|
147
|
+
|
|
148
|
+
<img className="block dark:hidden" src="/images/checkout-examples/discount-applied-light.webp" alt="VoiceForge AI Creator checkout with VOICE50 applied, $11 discount, $11 total" />
|
|
149
|
+
<img className="hidden dark:block" src="/images/checkout-examples/discount-applied-dark.webp" alt="VoiceForge AI Creator checkout with VOICE50 applied, $11 discount, $11 total" />
|
|
150
|
+
|
|
151
|
+
[See example →](https://www.kelviq.com/sandbox/buy/f60cea73-579b-4932-8d85-02b79710e9dc/?enabled=voice-creator&plan_identifier=voice-creator&charge_period=MONTHLY&discounts_enabled=true&discount_code=VOICE50)
|
|
152
|
+
|
|
153
|
+
The code must be active and valid for the plan and currency. [How checkout discounts work →](/checkout/apply-a-discount-code)
|
|
154
|
+
|
|
155
|
+
## Discount field hidden
|
|
156
|
+
|
|
157
|
+
You can also remove the **Add promotion code** field, so customers aren't tempted to leave and search for a code. This link adds `discounts_enabled=false`.
|
|
158
|
+
|
|
159
|
+
<img className="block dark:hidden" src="/images/checkout-examples/discount-hidden-light.webp" alt="VoiceForge AI Creator checkout without a promotion code field" />
|
|
160
|
+
<img className="hidden dark:block" src="/images/checkout-examples/discount-hidden-dark.webp" alt="VoiceForge AI Creator checkout without a promotion code field" />
|
|
161
|
+
|
|
162
|
+
[See example →](https://www.kelviq.com/sandbox/buy/f60cea73-579b-4932-8d85-02b79710e9dc/?enabled=voice-creator&plan_identifier=voice-creator&charge_period=MONTHLY&discounts_enabled=false)
|
|
163
|
+
|
|
164
|
+
## Per-seat plan
|
|
165
|
+
|
|
166
|
+
A per-seat plan charges for each seat the customer buys. The seat count comes from your app, so this checkout is created with the [Checkout API](/api-reference/checkout/create-a-checkout-session) rather than a static link. This example offers TeamBoard Basic and Business for 5 seats, with Business selected: \$16 a seat, \$80 a month, after a 14-day trial.
|
|
167
|
+
|
|
168
|
+
<img className="block dark:hidden" src="/images/checkout-examples/per-seat-light.webp" alt="TeamBoard checkout with Basic and Business plans, Business selected with 5 seats at $80 a month" />
|
|
169
|
+
<img className="hidden dark:block" src="/images/checkout-examples/per-seat-dark.webp" alt="TeamBoard checkout with Basic and Business plans, Business selected with 5 seats at $80 a month" />
|
|
170
|
+
|
|
171
|
+
```json
|
|
172
|
+
{
|
|
173
|
+
"planIdentifier": "tb-business",
|
|
174
|
+
"plansEnabled": "tb-basic,tb-business",
|
|
175
|
+
"chargePeriod": "MONTHLY",
|
|
176
|
+
"features": [{ "identifier": "tb-seats", "quantity": 5 }],
|
|
177
|
+
"successUrl": "https://example.com/welcome"
|
|
178
|
+
}
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
The response has a `checkoutUrl` to send the customer to. See [Seat-based pricing](/product-catalog/seat-based-pricing) for how to set up the plan.
|
|
182
|
+
|
|
183
|
+
## Prefilled customer
|
|
184
|
+
|
|
185
|
+
Add `customer_id` to the link for a customer your app already knows, and checkout fills in their name and email. The purchase is attached to that customer record.
|
|
186
|
+
|
|
187
|
+
<img className="block dark:hidden" src="/images/checkout-examples/prefilled-customer-light.webp" alt="VoiceForge AI Pro checkout with the email and name already filled in" />
|
|
188
|
+
<img className="hidden dark:block" src="/images/checkout-examples/prefilled-customer-dark.webp" alt="VoiceForge AI Pro checkout with the email and name already filled in" />
|
|
189
|
+
|
|
190
|
+
[See example →](https://www.kelviq.com/sandbox/buy/f60cea73-579b-4932-8d85-02b79710e9dc/?enabled=voice-pro&plan_identifier=voice-pro&charge_period=MONTHLY&customer_id=cust_demo_jane)
|
|
191
|
+
|
|
192
|
+
## Business purchase
|
|
193
|
+
|
|
194
|
+
Every checkout has an **I'm purchasing as a business** box. Ticking it adds fields for the company name, address, and tax ID, which then appear on the invoice.
|
|
195
|
+
|
|
196
|
+
<img className="block dark:hidden" src="/images/checkout-examples/business-purchase-light.webp" alt="VoiceForge AI Pro checkout with the business purchase fields open" />
|
|
197
|
+
<img className="hidden dark:block" src="/images/checkout-examples/business-purchase-dark.webp" alt="VoiceForge AI Pro checkout with the business purchase fields open" />
|
|
198
|
+
|
|
199
|
+
[See example →](https://www.kelviq.com/sandbox/buy/f60cea73-579b-4932-8d85-02b79710e9dc/?enabled=voice-pro&plan_identifier=voice-pro&charge_period=MONTHLY)
|
|
200
|
+
|
|
201
|
+
## Redirect after payment
|
|
202
|
+
|
|
203
|
+
To send the customer back to your app after they pay, add `success_url` with the address of your page. Checkout itself looks the same. This example sends the customer to `https://example.com/welcome`.
|
|
204
|
+
|
|
205
|
+
[See example →](https://www.kelviq.com/sandbox/buy/f60cea73-579b-4932-8d85-02b79710e9dc/?enabled=voice-pro&plan_identifier=voice-pro&charge_period=MONTHLY&success_url=https%3A%2F%2Fexample.com%2Fwelcome)
|
|
206
|
+
|
|
207
|
+
## Related documentation
|
|
208
|
+
|
|
209
|
+
- [Customize a static checkout URL](/checkout/static-checkout-url)
|
|
210
|
+
- [Checkout configuration](/checkout/checkout-configuration)
|
|
211
|
+
- [Free plans and trials](/product-catalog/free-and-trials)
|
|
212
|
+
- [Create a checkout session with the API](/api-reference/checkout/create-a-checkout-session)
|
|
@@ -26,7 +26,7 @@ Use metadata for values that help your backend connect a completed checkout to i
|
|
|
26
26
|
|
|
27
27
|
You need:
|
|
28
28
|
|
|
29
|
-
- a server API key from **Settings → API
|
|
29
|
+
- a server API key from **Settings → API keys**;
|
|
30
30
|
- a plan identifier and supported charge period;
|
|
31
31
|
- a backend endpoint that creates checkout sessions.
|
|
32
32
|
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Custom fields"
|
|
3
|
+
slug: "checkout/custom-fields"
|
|
4
|
+
section: "checkout"
|
|
5
|
+
description: "Ask customers for extra information at checkout, such as a company name, PO number, or use case"
|
|
6
|
+
---
|
|
7
|
+
Custom fields add your own questions to checkout. Use them for anything Kelviq doesn't already collect, such as a company name for the invoice, a purchase order number, a team size, or agreement to your terms.
|
|
8
|
+
|
|
9
|
+
You create a field once in Settings, then choose which checkout links or checkout sessions should ask it.
|
|
10
|
+
|
|
11
|
+
## Create a field
|
|
12
|
+
|
|
13
|
+
1. Open **Settings → Custom fields** and click **Create custom field**.
|
|
14
|
+
2. Pick a **Field type** and decide whether the field is **required**.
|
|
15
|
+
3. Enter the **Field label**, the question customers see above the input.
|
|
16
|
+
4. Add optional **Help text**, shown below the input, and a **Placeholder** that shows the expected format.
|
|
17
|
+
5. Set the validation for the type you picked, and the **Validation error message** customers see when their answer doesn't pass.
|
|
18
|
+
6. Click **Create field**.
|
|
19
|
+
|
|
20
|
+
<img width="480" src="/images/settings/custom-field-create.webp" alt="The Create string field dialog with a required Company name field, help text, placeholder, and length limits" />
|
|
21
|
+
|
|
22
|
+
## Field types
|
|
23
|
+
|
|
24
|
+
| Type | What the customer enters | Validation you can set |
|
|
25
|
+
| --- | --- | --- |
|
|
26
|
+
| **String** | A single line of text | Minimum and maximum length, and a regex pattern the answer must match |
|
|
27
|
+
| **Number** | A number | Minimum and maximum value |
|
|
28
|
+
| **Boolean** | Yes or no, with a checkbox | Required or not |
|
|
29
|
+
| **Email** | An email address | Checked as a valid email |
|
|
30
|
+
| **Dropdown** | One option from a list you define. Each option has a value and a label. | The answer must be one of your options |
|
|
31
|
+
| **URL** | A web address | Checked as a valid URL |
|
|
32
|
+
| **Date** | A date, in `YYYY-MM-DD` format | Earliest and latest date |
|
|
33
|
+
|
|
34
|
+
Use a required **Boolean** field for "I agree to the terms" style checkboxes.
|
|
35
|
+
|
|
36
|
+
## Add a field to checkout
|
|
37
|
+
|
|
38
|
+
**Checkout links:** on the product page, click **Get Link**. Under **Assign custom field**, choose the field, then copy the checkout link. Customers who open that link see the question.
|
|
39
|
+
|
|
40
|
+
**Checkout sessions from the API:** pass the field identifiers in `customFields` when you [create a checkout session](/api-reference/checkout/create-a-checkout-session):
|
|
41
|
+
|
|
42
|
+
```json
|
|
43
|
+
{
|
|
44
|
+
"planIdentifier": "pro-plan",
|
|
45
|
+
"chargePeriod": "MONTHLY",
|
|
46
|
+
"successUrl": "https://example.com/welcome",
|
|
47
|
+
"customFields": ["company-name", "purchase-order-number"]
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Fields appear in the order they're sorted in Settings. Each answer is checked against the field's type and validation before payment. Identifiers that don't exist or belong to archived fields are ignored.
|
|
52
|
+
|
|
53
|
+
Editing a field changes it on every checkout link that already uses it.
|
|
54
|
+
|
|
55
|
+
## Where the answers go
|
|
56
|
+
|
|
57
|
+
Answers are saved with the [checkout session](/sales/checkout-sessions) and the [order](/sales/orders) and subscription it creates. Through the API and webhooks they arrive keyed by field identifier:
|
|
58
|
+
|
|
59
|
+
* `customFieldsData` on orders, checkout sessions, and invoices in the API.
|
|
60
|
+
* `custom_fields_data` in the `checkout.completed`, `order.created`, `order.updated`, and `order.refunded` [webhooks](/guides/webhooks#custom-field-responses).
|
|
@@ -0,0 +1,280 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Embed checkout on your site"
|
|
3
|
+
slug: "checkout/embed-checkout"
|
|
4
|
+
section: "checkout"
|
|
5
|
+
description: "Open Kelviq Checkout as an overlay or mount it inline on your own page with kelviq.js"
|
|
6
|
+
---
|
|
7
|
+
By default, a checkout link sends the customer to a Kelviq-hosted page. With the `@kelviq/js-checkout` SDK you can keep the customer on your site instead: open checkout as a **modal overlay** over your current page, or mount it **inline** inside your own layout. The SDK reports the checkout lifecycle (loaded, success, close, error) back to callbacks you provide.
|
|
8
|
+
|
|
9
|
+
It is a small script with no dependencies. It works with plain HTML and with any framework.
|
|
10
|
+
|
|
11
|
+
Embedded checkout needs a **checkout session URL** created with the [Checkout API](/api-reference/checkout/create-a-checkout-session). Static `/buy/` links are not supported in embedded mode yet.
|
|
12
|
+
|
|
13
|
+
## 1. Install the SDK
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm install @kelviq/js-checkout
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
import { open, embed } from '@kelviq/js-checkout';
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
The package ships ESM and TypeScript types. The examples below use the `Kelviq` global; with npm, call `open()` and `embed()` directly instead.
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
Add the script tag to any page that opens checkout. It defines one global, `Kelviq`.
|
|
31
|
+
|
|
32
|
+
```html
|
|
33
|
+
<script src="https://cdn.jsdelivr.net/npm/@kelviq/js-checkout@1/dist/kelviq.js"></script>
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
The `@1` pin receives backwards-compatible updates automatically. Do not copy the file to your own server: the SDK and the checkout page share one messaging protocol, and Kelviq updates both together.
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
## 2. Create a checkout session
|
|
40
|
+
|
|
41
|
+
Create the session from your backend with your server API key and pass the returned `checkoutUrl` to the browser. The same call accepts a customer, discount code, metadata, and the other options described in [Create a checkout session](/api-reference/checkout/create-a-checkout-session).
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
curl -X POST https://api.kelviq.com/api/v1/checkout/ \
|
|
45
|
+
-H "Authorization: Bearer $KELVIQ_SERVER_API_KEY" \
|
|
46
|
+
-H "Content-Type: application/json" \
|
|
47
|
+
-d '{
|
|
48
|
+
"planIdentifier": "pro",
|
|
49
|
+
"chargePeriod": "MONTHLY",
|
|
50
|
+
"customerId": "cust_789"
|
|
51
|
+
}'
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
```json
|
|
55
|
+
{
|
|
56
|
+
"checkoutUrl": "https://checkout.kelviq.com/checkout/cs_eeCGdGayc5oTMdGNV5XocfRk6o87K0vlwwCuKeiE7BLU9/",
|
|
57
|
+
"checkoutSessionId": "cs_eeCGdGayc5oTMdGNV5XocfRk6o87K0vlwwCuKeiE7BLU9"
|
|
58
|
+
}
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Leave `successUrl` out of sessions you open with `kelviq.js` if you want the `onSuccess` callback. A session with a `successUrl` redirects your whole page to that URL when payment completes, and `onSuccess` never fires. See [Success callback or redirect](#success-callback-or-redirect).
|
|
62
|
+
|
|
63
|
+
Pass the `checkoutUrl` to the browser exactly as returned. Do not rewrite its host: the script only accepts messages from the origin of the URL you give it.
|
|
64
|
+
|
|
65
|
+
## 3. Open checkout
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
Open checkout as a modal over the current page. Good for a **Buy** button anywhere on your site.
|
|
70
|
+
|
|
71
|
+
```html
|
|
72
|
+
<button id="buy">Buy Pro</button>
|
|
73
|
+
|
|
74
|
+
<script>
|
|
75
|
+
document.getElementById('buy').addEventListener('click', async () => {
|
|
76
|
+
// Your backend creates the session and returns { checkoutUrl }
|
|
77
|
+
const { checkoutUrl } = await fetch('/api/checkout', { method: 'POST' })
|
|
78
|
+
.then((r) => r.json());
|
|
79
|
+
|
|
80
|
+
Kelviq.open({
|
|
81
|
+
url: checkoutUrl,
|
|
82
|
+
onSuccess: (order) => {
|
|
83
|
+
console.log('Paid', order.orderId, order.planName);
|
|
84
|
+
},
|
|
85
|
+
onClose: () => {
|
|
86
|
+
console.log('Checkout closed');
|
|
87
|
+
},
|
|
88
|
+
});
|
|
89
|
+
});
|
|
90
|
+
</script>
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
`Kelviq.open()` returns a handle with `close()`. The overlay also closes when the customer clicks the × button, presses Escape, or clicks the backdrop.
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
Mount checkout inside an element on your page. Good for a dedicated checkout page on your own domain. The frame resizes itself to the checkout's height.
|
|
99
|
+
|
|
100
|
+
```html
|
|
101
|
+
<div id="checkout"></div>
|
|
102
|
+
|
|
103
|
+
<script>
|
|
104
|
+
const handle = Kelviq.embed({
|
|
105
|
+
url: checkoutUrl, // from your backend
|
|
106
|
+
container: '#checkout',
|
|
107
|
+
onSuccess: (order) => {
|
|
108
|
+
console.log('Paid', order.orderId);
|
|
109
|
+
},
|
|
110
|
+
});
|
|
111
|
+
|
|
112
|
+
// In a single-page app, unmount when the user navigates away:
|
|
113
|
+
// handle.destroy();
|
|
114
|
+
</script>
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
`container` accepts a CSS selector or an `HTMLElement`. `Kelviq.embed()` returns a handle with `destroy()`.
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
## Options
|
|
121
|
+
|
|
122
|
+
Both methods take `url`, the optional `theme`, and the callbacks below. `Kelviq.open()` also accepts the overlay options.
|
|
123
|
+
|
|
124
|
+
### Color mode (`theme`)
|
|
125
|
+
|
|
126
|
+
| Option | Type | Default | Description |
|
|
127
|
+
| --- | --- | --- | --- |
|
|
128
|
+
| `theme` | `"light" \| "dark" \| "system"` | Dashboard default | The color mode the checkout renders in, so it matches your page. `"system"` follows the customer's OS preference. Requires `@kelviq/js-checkout` 1.1.0 or later. |
|
|
129
|
+
|
|
130
|
+
Pass the mode your page is currently showing. When you omit it, the **Default mode** configured in the dashboard applies. The checkout's own light/dark switcher is hidden whenever it is embedded; your page decides.
|
|
131
|
+
|
|
132
|
+
```js
|
|
133
|
+
Kelviq.open({
|
|
134
|
+
url: checkoutUrl,
|
|
135
|
+
theme: document.documentElement.classList.contains('dark') ? 'dark' : 'light',
|
|
136
|
+
});
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Callbacks
|
|
140
|
+
|
|
141
|
+
| Callback | When it fires | Argument |
|
|
142
|
+
| --- | --- | --- |
|
|
143
|
+
| `onLoaded` | The checkout has finished loading | — |
|
|
144
|
+
| `onSuccess` | Payment completed and the confirmation rendered inside the checkout (sessions without a `successUrl` only) | `{ orderId, planName, amount, currency, email }` (all optional) |
|
|
145
|
+
| `onClose` | The checkout was closed: × button, Escape, backdrop click, the checkout's own back action, or `handle.close()` / `handle.destroy()` | — |
|
|
146
|
+
| `onError` | The session cannot be checked out: expired, not found, or a network failure. The checkout shows its own error page | `{ code, message }` (both optional), for example `ERR_SESSION_EXPIRED` or `ERR_SESSION_NOT_FOUND` |
|
|
147
|
+
|
|
148
|
+
`onClose` does not fire when the checkout is about to redirect your page (see below). Use `onError` to recover, for example by creating a fresh session and opening it again.
|
|
149
|
+
|
|
150
|
+
### Overlay options (`Kelviq.open` only)
|
|
151
|
+
|
|
152
|
+
| Option | Type | Default | Description |
|
|
153
|
+
| --- | --- | --- | --- |
|
|
154
|
+
| `size` | `"sm" \| "md" \| "lg"` | `"md"` | Modal width preset: 480px, 960px, or 1120px. `md` and `lg` show the two-column checkout; `sm` stacks it in one column |
|
|
155
|
+
| `width` | CSS length | — | Explicit modal width; overrides `size` |
|
|
156
|
+
| `height` | CSS length | `"720px"` | Explicit modal height |
|
|
157
|
+
| `showCloseButton` | `boolean` | `true` | Render the × button in the corner |
|
|
158
|
+
| `dismissible` | `boolean` | `true` | Close on Escape or backdrop click. The × button and `handle.close()` always work |
|
|
159
|
+
| `title` | `string` | `"Checkout"` | Accessible label for the dialog |
|
|
160
|
+
|
|
161
|
+
The modal never exceeds the viewport: width and height are capped at the viewport size minus a 24px margin on each side. On phones (viewports up to 519px wide) it opens as a full-screen sheet instead.
|
|
162
|
+
|
|
163
|
+
### Handles
|
|
164
|
+
|
|
165
|
+
```ts
|
|
166
|
+
const overlay = Kelviq.open({ url }); // { close(), update() }
|
|
167
|
+
const inline = Kelviq.embed({ url, container }); // { destroy(), update() }
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
Opening a second overlay closes the first one. Calling `close()` or `destroy()` twice is safe.
|
|
171
|
+
|
|
172
|
+
### Change the plan from your page (`update`)
|
|
173
|
+
|
|
174
|
+
`update({ planIdentifier?, chargePeriod? })` switches the plan or billing period of the running checkout in place, without reloading it or losing what the customer typed. Use it when your own page has the pricing controls, for example a monthly/yearly toggle next to an inline checkout. Requires `@kelviq/js-checkout` 1.1.0 or later.
|
|
175
|
+
|
|
176
|
+
```js
|
|
177
|
+
const inline = Kelviq.embed({ url: checkoutUrl, container: '#checkout' });
|
|
178
|
+
|
|
179
|
+
document.querySelector('#yearly').addEventListener('change', (event) => {
|
|
180
|
+
inline.update({ chargePeriod: event.target.checked ? 'YEARLY' : 'MONTHLY' });
|
|
181
|
+
});
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
- Values must exist on the session: a plan from the offering and one of its enabled billing periods. The checkout ignores anything else.
|
|
185
|
+
- If you change only the period and the current plan has no price for it, the checkout picks the first plan that does, as its own period tabs do.
|
|
186
|
+
- Calls made before `onLoaded` are queued and applied once the checkout has loaded.
|
|
187
|
+
- To hide the checkout's own plan selector and keep yours as the single source of truth, create the session with `plansEnabled: false`.
|
|
188
|
+
|
|
189
|
+
## Use with a framework
|
|
190
|
+
|
|
191
|
+
Call the SDK only in the browser, after the component has mounted, and clean up with the handle when the component unmounts. Never call it during server rendering.
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
```tsx
|
|
196
|
+
import { useEffect, useRef } from 'react';
|
|
197
|
+
import { embed, open } from '@kelviq/js-checkout';
|
|
198
|
+
|
|
199
|
+
// Inline checkout on a dedicated page
|
|
200
|
+
export function InlineCheckout({ url }: { url: string }) {
|
|
201
|
+
const container = useRef<HTMLDivElement>(null);
|
|
202
|
+
|
|
203
|
+
useEffect(() => {
|
|
204
|
+
if (!container.current) return;
|
|
205
|
+
const handle = embed({
|
|
206
|
+
url,
|
|
207
|
+
container: container.current,
|
|
208
|
+
onSuccess: (order) => console.log('paid', order.orderId),
|
|
209
|
+
});
|
|
210
|
+
return () => handle.destroy();
|
|
211
|
+
}, [url]);
|
|
212
|
+
|
|
213
|
+
return <div ref={container} />;
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
// Overlay from a button
|
|
217
|
+
export function BuyButton({ url }: { url: string }) {
|
|
218
|
+
return <button onClick={() => open({ url })}>Buy</button>;
|
|
219
|
+
}
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
In Next.js, mark the component with `'use client'`. The `url` comes from a server action or route handler that calls the Checkout API with your server API key.
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
```vue
|
|
228
|
+
<script setup lang="ts">
|
|
229
|
+
import { onBeforeUnmount, onMounted, ref } from 'vue';
|
|
230
|
+
import { embed, type KelviqEmbedHandle } from '@kelviq/js-checkout';
|
|
231
|
+
|
|
232
|
+
const props = defineProps<{ url: string }>();
|
|
233
|
+
const container = ref<HTMLElement>();
|
|
234
|
+
let handle: KelviqEmbedHandle | undefined;
|
|
235
|
+
|
|
236
|
+
onMounted(() => {
|
|
237
|
+
handle = embed({ url: props.url, container: container.value! });
|
|
238
|
+
});
|
|
239
|
+
onBeforeUnmount(() => handle?.destroy());
|
|
240
|
+
</script>
|
|
241
|
+
|
|
242
|
+
<template><div ref="container" /></template>
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
## Success callback or redirect
|
|
247
|
+
|
|
248
|
+
A checkout session ends in exactly one of two ways, decided by whether it has a `successUrl`:
|
|
249
|
+
|
|
250
|
+
| Session | On payment success |
|
|
251
|
+
| --- | --- |
|
|
252
|
+
| **Without `successUrl`** | The confirmation screen renders inside the overlay or frame and `onSuccess` fires with the order details. Your page does not navigate. |
|
|
253
|
+
| **With `successUrl`** | Your whole page (not just the frame) navigates to `successUrl`. `onSuccess` and `onClose` do not fire. |
|
|
254
|
+
|
|
255
|
+
If you rely on `onSuccess` for analytics or to update your UI, create the session without a `successUrl`. For fulfilment, use the [`checkout.completed` webhook](/guides/webhooks) in either case: a browser callback can be missed if the customer closes the tab.
|
|
256
|
+
|
|
257
|
+
## Sandbox
|
|
258
|
+
|
|
259
|
+
Sessions created with a sandbox server API key return a sandbox `checkoutUrl`. Pass it to `kelviq.js` the same way; the script works with both environments. Use a test card (for example `4242 4242 4242 4242`) to complete a test payment. See [Sandbox](/guides/sandbox) and [Test payments](/guides/test-payments).
|
|
260
|
+
|
|
261
|
+
## Browser support
|
|
262
|
+
|
|
263
|
+
- **Your page (the SDK)**: every browser Stripe.js supports, including Chrome 38+, Safari 10.1+, Firefox 29+, Edge 15+, iOS Safari 9+ and Android Chrome 38+. The script never breaks the host page on an unsupported browser.
|
|
264
|
+
- **The checkout inside the frame**: Chrome and Edge 99+, Firefox 97+, Safari 15.4+. On older browsers the customer sees a "browser not supported" message instead of the form, and `onClose` still fires if they dismiss it.
|
|
265
|
+
|
|
266
|
+
## Limitations
|
|
267
|
+
|
|
268
|
+
- **Static checkout links** (`https://www.kelviq.com/buy/…`) cannot be embedded yet. Create a session with the Checkout API and embed its `checkoutUrl`.
|
|
269
|
+
- **Redirect-based payment methods** such as iDEAL and Bancontact are not supported in embedded mode. Card payments, including 3D Secure challenges, work.
|
|
270
|
+
- Kelviq controls which sites may frame the checkout. If your embed renders blank and the browser console reports a `frame-ancestors` violation, contact [hi@kelviq.com](mailto:hi@kelviq.com) with the domain you embed from.
|
|
271
|
+
|
|
272
|
+
## Troubleshooting
|
|
273
|
+
|
|
274
|
+
Check the browser console. A Content-Security-Policy `frame-ancestors` error means the page is not allowed to frame Kelviq Checkout from your domain. A 404 inside the frame means the session ID is wrong or the session has expired.
|
|
275
|
+
|
|
276
|
+
The session was created with a `successUrl`, so the page redirected instead. Create the session without a `successUrl`, or handle the redirect landing page on your side.
|
|
277
|
+
|
|
278
|
+
The session has expired, was already used, or could not be loaded. `onError` fires with a `code` such as `ERR_SESSION_EXPIRED`; create a new session and open it again.
|
|
279
|
+
|
|
280
|
+
Make sure you passed the `checkoutUrl` exactly as the API returned it. The script ignores messages from any other origin, including a different subdomain of the same host.
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Accept UPI and UPI AutoPay payments"
|
|
3
|
+
slug: "checkout/payment-methods/upi"
|
|
4
|
+
section: "checkout"
|
|
5
|
+
description: "Take one-time UPI payments and UPI AutoPay subscriptions from customers in India, with no UPI setup of your own"
|
|
6
|
+
---
|
|
7
|
+
UPI is the most used way to pay online in India. Your customer scans a QR code with any UPI app, such as Google Pay, PhonePe, Paytm or their bank's app, and approves the payment there.
|
|
8
|
+
|
|
9
|
+
You don't sign up with a UPI provider or a bank. Kelviq is the merchant of record, so UPI shows up at checkout for the right customers and the money reaches you in your normal [payout](/payouts/overview).
|
|
10
|
+
|
|
11
|
+
## Who sees UPI at checkout
|
|
12
|
+
|
|
13
|
+
UPI appears when both of these are true:
|
|
14
|
+
|
|
15
|
+
| Condition | Why |
|
|
16
|
+
| --- | --- |
|
|
17
|
+
| The customer is in India | UPI is an Indian payment network. |
|
|
18
|
+
| The checkout is priced in INR | UPI only works in rupees. |
|
|
19
|
+
|
|
20
|
+
To get there, add a localized INR price to your plan with [Price localization](/product-catalog/location-based-pricing). Customers in India then see the INR price, and UPI next to cards and wallets.
|
|
21
|
+
|
|
22
|
+
## One-time payments
|
|
23
|
+
|
|
24
|
+
The customer picks UPI at checkout, scans the QR code with their UPI app and approves the payment.
|
|
25
|
+
|
|
26
|
+
* A single payment can be from ₹1 up to ₹1,00,000.
|
|
27
|
+
* QR codes expire after 5 minutes.
|
|
28
|
+
* Checkout supports UPI by QR code only. Customers can't enter a UPI ID.
|
|
29
|
+
|
|
30
|
+
## Subscriptions with UPI AutoPay
|
|
31
|
+
|
|
32
|
+
For a subscription, the customer approves a UPI AutoPay mandate in their UPI app at checkout. Kelviq then charges each renewal automatically.
|
|
33
|
+
|
|
34
|
+
| | One-time payment | UPI AutoPay renewal |
|
|
35
|
+
| --- | --- | --- |
|
|
36
|
+
| Amount per payment | ₹1 to ₹1,00,000 | Up to ₹15,000 per charge |
|
|
37
|
+
| Customer action | Scan and approve each time | Approve the mandate once at checkout |
|
|
38
|
+
| Failed payments | Not applicable | Retried for up to 14 days, then the subscription is canceled |
|
|
39
|
+
|
|
40
|
+
UPI AutoPay depends on the customer's bank and UPI app supporting it. Failed renewals follow the same retry schedule as cards. See [failed subscription payments](/product-catalog/subscriptions#failed-subscription-payments).
|
|
41
|
+
|
|
42
|
+
If you [change a plan's price](/product-catalog/plans) and migrate existing customers, a UPI AutoPay mandate may need the customer to approve a renewal when the new amount is above the applicable regulatory threshold.
|
|
43
|
+
|
|
44
|
+
## Refunds
|
|
45
|
+
|
|
46
|
+
Refund a UPI payment from the order in [Orders](/sales/orders) with **Refund payment**. You can refund up to 60 days after the payment. The money takes up to 7 business days to reach the customer.
|
|
47
|
+
|
|
48
|
+
As with every refund on Kelviq, the transaction fee isn't returned and the tax part goes back to the customer.
|
|
49
|
+
|
|
50
|
+
To find UPI payments, search for `upi` in [Transactions](/payouts/transactions).
|
|
51
|
+
|
|
52
|
+
## UPI questions
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
No. Kelviq is the merchant of record and collects UPI payments for you. You only need an INR price on your plan.
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
Not at the moment. Kelviq checkout supports UPI by QR code.
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
Yes. Each UPI AutoPay renewal can be up to ₹15,000. One-time UPI payments can be up to ₹1,00,000.
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
Add an INR price so customers in India see UPI at checkout.
|