# Kelviq Documentation

## Docs

- [Authentication](https://docs.kelviq.com/api-reference/authentication.md)
- [Create a checkout session](https://docs.kelviq.com/api-reference/checkout/create-a-checkout-session.md): Creates a new checkout session for a customer to proceed with a purchase or subscription.
- [Create a customer](https://docs.kelviq.com/api-reference/customers/create-a-customer.md): Creates a new customer record within kelviq.
- [Update a customer](https://docs.kelviq.com/api-reference/customers/update-a-customer.md): Performs a partial update on an existing customer using their client-defined `customerId`.
- [Retrieve customer entitlements](https://docs.kelviq.com/api-reference/entitlements/retrieve-customer-entitlements.md): Retrieves detailed entitlement information for a customer. - If `feature_idd` is provided as a query parameter, returns details for that specific feature. - If `feature_id` is omitted, returns all entitlements for the customer.
- [Activate License](https://docs.kelviq.com/api-reference/license/activate-license.md): Activates a license key for a specific instance.
- [Deactivate License](https://docs.kelviq.com/api-reference/license/deactivate-license.md)
- [Validate License](https://docs.kelviq.com/api-reference/license/validate-license.md)
- [Get Product Offering](https://docs.kelviq.com/api-reference/monetization/get-product-offering.md): Retrieves the public pricing details for a specific product, including all eligible plans, localized pricing, and the customer's current subscription state. Use this to render a pricing page or paywall scoped to a product.
- [Get Public Offering](https://docs.kelviq.com/api-reference/monetization/get-public-offering.md): Retrieves the public details of a specific offering, which can be used to render a pricing page or paywall.
- [Create a portal session](https://docs.kelviq.com/api-reference/portal/create-a-portal-session.md): Creates a new customer portal session, returning a token and URL to redirect the customer to their billing portal.
- [Get promotions](https://docs.kelviq.com/api-reference/promotions/get-promotions.md): Resolves the active promotion for the caller's detected location. Returns the applicable discount percentage, coupon code, banner widget configuration, and security check results.
- [Report pre-aggregated usage](https://docs.kelviq.com/api-reference/reporting/report-pre-aggregated-usage.md): Reports pre-aggregated feature usage from your application to kelviq.
- [Cancel a subscription](https://docs.kelviq.com/api-reference/subscriptions/cancel-a-subscription.md): Cancels an active subscription for a customer.
- [Create a subscription](https://docs.kelviq.com/api-reference/subscriptions/create-a-subscription.md): Creates a new subscription for a customer directly, without requiring a checkout session.
- [List Subscriptions](https://docs.kelviq.com/api-reference/subscriptions/list-subscriptions.md): Retrieves a paginated list of subscriptions. You can filter the results by customer.
- [Update a subscription](https://docs.kelviq.com/api-reference/subscriptions/update-a-subscription.md): Updates an existing subscription to a new plan, charge period, and/or features.
- [Node SDK](https://docs.kelviq.com/backend-integration/node-sdk.md): Documentation for the Kelviq Node SDK
- [Python SDK](https://docs.kelviq.com/backend-integration/python-sdk.md): Documentation for the Kelviq Python SDK
- [App](https://docs.kelviq.com/changelog/app.md): Changelog for the Kelviq Dashboard
- [JS SDK](https://docs.kelviq.com/changelog/js-sdk.md): Changelog for @kelviq/js-sdk
- [Node SDK](https://docs.kelviq.com/changelog/node-sdk.md): Changelog for @kelviq/node-sdk
- [Python SDK](https://docs.kelviq.com/changelog/python-sdk.md): Changelog for kelviq-sdk (Python)
- [React SDK](https://docs.kelviq.com/changelog/react-sdk.md): Changelog for @kelviq/react-sdk
- [Configuration & Customization](https://docs.kelviq.com/checkout/checkout-configuration.md): Configure and customize checkout experiences for your customers
- [Overview](https://docs.kelviq.com/coustomers-management/overview.md): View and manage customer details, subscriptions, and entitlements.
- [Customer portal](https://docs.kelviq.com/customer-portal/overview.md): A self-serve hub for your customers to manage subscriptions and access content.
- [JavaScript SDK](https://docs.kelviq.com/frontend-integration/js-sdk.md): Documentation for the Kelviq JavaScript SDK
- [Promotions UI JS SDK](https://docs.kelviq.com/frontend-integration/promotions-ui-js.md): Add purchasing power parity discounts and a localised banner to any website
- [React Promotions UI](https://docs.kelviq.com/frontend-integration/react-promotions-ui.md): Add purchasing power parity discounts and a localised banner to your React app
- [React SDK](https://docs.kelviq.com/frontend-integration/react-sdk.md): Documentation for the Kelviq React SDK
- [React UI](https://docs.kelviq.com/frontend-integration/react-ui.md): Documentation for the kelviq React UI SDK - A comprehensive pricing table and paywall solution
- [Fees](https://docs.kelviq.com/getstarted/fees.md): Kelviq's transparent pricing structure
- [Introduction to kelviq](https://docs.kelviq.com/getstarted/introduction-to-kelviq.md)
- [Merchant of Record](https://docs.kelviq.com/getstarted/merchant-of-record.md)
- [Review Process](https://docs.kelviq.com/getstarted/review-process.md)
- [Subscription Integration](https://docs.kelviq.com/guides/subscription-integration.md): A simple guide to add subscription billing to your SaaS in 5 API calls.
- [Subscription Integration for Next.js](https://docs.kelviq.com/guides/subscription-integration-for-nextjs.md): A step-by-step guide to add subscription billing and entitlements to your Next.js app.
- [Webhooks](https://docs.kelviq.com/guides/webhooks.md): Receive real-time event notifications from Kelviq to your server.
- [Acceptable Use Policy](https://docs.kelviq.com/legal/approved-prohibited-policy.md): Kelviq's policy on approved, restricted, and prohibited business categories
- [Buyer Terms](https://docs.kelviq.com/legal/buyer-terms.md): Terms and conditions for buyers purchasing through Kelviq
- [Transaction Flow](https://docs.kelviq.com/legal/compliant-user-flow.md): End-to-end user flow documentation for the Kelviq Merchant of Record platform
- [Seller Agreement](https://docs.kelviq.com/legal/master-service-agreement.md): Master Service Agreement for sellers using the Kelviq platform
- [Payment Processing](https://docs.kelviq.com/legal/payment-flow-diagram.md): Stripe Connect integration and payment flow documentation for Kelviq
- [Seller Terms](https://docs.kelviq.com/legal/seller-terms.md): Platform Terms of Service for sellers using Kelviq
- [Offerings](https://docs.kelviq.com/monetization/offerings.md)
- [Pricing table](https://docs.kelviq.com/monetization/pricing-tables.md)
- [Targeting Rules](https://docs.kelviq.com/monetization/targeting-rules.md)
- [Overview](https://docs.kelviq.com/payouts/overview.md): Connect your bank account and track cash flow
- [Payout Settings](https://docs.kelviq.com/payouts/payout-account.md): Manage bank accounts and transfer schedules
- [Transactions](https://docs.kelviq.com/payouts/transactions.md): Audit individual payments, fees, and net earnings
- [Digital Downloads](https://docs.kelviq.com/product-catalog/digital-downloads.md): Enable customers to download digital files after purchase
- [Discounts](https://docs.kelviq.com/product-catalog/discounts.md): Create coupons and promotional codes
- [Features & Limits (Entitlements)](https://docs.kelviq.com/product-catalog/entitlements.md): Control feature access for your customers
- [License Key Management](https://docs.kelviq.com/product-catalog/license-keys.md): Generate and manage license keys for your products
- [Links](https://docs.kelviq.com/product-catalog/links.md): Share links with your customers
- [Plans](https://docs.kelviq.com/product-catalog/plans.md): Configure pricing, features, and deliverables
- [Products](https://docs.kelviq.com/product-catalog/products.md): Create and manage your high-level product containers
- [Create a promotion](https://docs.kelviq.com/promotions/create-a-promotion.md): Set up purchasing power parity discounts, country overrides, and security enforcement
- [Customize the banner](https://docs.kelviq.com/promotions/customize-banner.md): Adjust the appearance and behavior of the Promotions UI banner to match your brand
- [Integrate the Promotions UI](https://docs.kelviq.com/promotions/integrate.md): Add the Kelviq promotions banner to your app using HTML/JS, React, or the Direct API
- [Promotions](https://docs.kelviq.com/promotions/overview.md): Boost global sales with purchasing power parity and country-specific discounts
- [Core concepts](https://docs.kelviq.com/quickstart/core-concepts.md)
- [Dashboard setup](https://docs.kelviq.com/quickstart/dashboard-setup.md)
- [Integrate with your app](https://docs.kelviq.com/quickstart/integrate-with-your-app.md)
- [Checkout Sessions](https://docs.kelviq.com/sales/checkout-sessions.md): Monitor live traffic and debug failed purchase attempts
- [Orders](https://docs.kelviq.com/sales/orders.md): Track revenue and manage individual customer purchases

## OpenAPI Specs

- [openapi](https://docs.kelviq.com/api-reference/openapi.json)