# Churnkey Documentation

> Documentation for Churnkey — cancel flows, failed payment recovery, reactivations, customer health, and billing provider integrations.

> Every page is also available as plain markdown by appending `.md` to its URL (e.g. `https://docs.churnkey.co/cancel-flows/quick-start-guide.md`).

## Getting Started

- [Overview](https://docs.churnkey.co/getting-started): Everything you need to know about integrating Churnkey with your product and billing stack.

## Cancel Flows

- [Quick Start Guide](https://docs.churnkey.co/cancel-flows/quick-start-guide): A 3-step guide on how to implement Cancel Flows in your website
- [Cancel Flow Structure](https://docs.churnkey.co/cancel-flows/flow-configuration): Learn about the available components that make up a Cancel Flow, from initial offers to cancellation confirmation, and how each step contributes to the overall flow.
- [Configuration Options](https://docs.churnkey.co/cancel-flows/further-configuration): Additional details for all of the following options are included below.
- [Custom Styling](https://docs.churnkey.co/cancel-flows/custom-styling): Brand your Churnkey Cancel Flow with your own CSS
- [Flow History & Version Control](https://docs.churnkey.co/cancel-flows/version-history): Protect your work in the Cancel Flow builder with undo, redo, discard, and one-click restore of any previously published version.
- [Managed Email Flow](https://docs.churnkey.co/cancel-flows/email-verified-cancel-flow): Our managed email based setup takes care of customer verification for you with an email verification code.
- [A/B Testing](https://docs.churnkey.co/cancel-flows/a-b-testing): Run controlled experiments to optimize your Cancel Flows and maximize customer retention.
- [Testing](https://docs.churnkey.co/cancel-flows/cancel-flow-testing): Ensure that your Cancel Flow is working as intended before going live.
- [Pause Wall](https://docs.churnkey.co/cancel-flows/pause-wall): Block access to your application during subscription pauses
- [Click-to-Cancel Compliance](https://docs.churnkey.co/cancel-flows/click-to-cancel): Implement automatic compliance with global subscription cancellation requirements
- [Structured Follow-Up Questions](https://docs.churnkey.co/cancel-flows/structured-follow-up-questions): Collect deeper cancellation insights and deliver targeted retention offers with a second layer of predefined follow-up options in your cancel flow survey.
- [Cancel Flow Settings](https://docs.churnkey.co/cancel-flows/cancel-flow-settings): Configure pause invoice behavior, coupon stacking, and session recording directly from the dashboard — no redeploy required.
- [Setup](https://docs.churnkey.co/cancel-flows/hosted-cancel-flow/setup): Enable the Hosted Cancel Flow and configure the core settings — return URL, link and code expirations, and feature toggles.
- [Domains](https://docs.churnkey.co/cancel-flows/hosted-cancel-flow/domains): Choose how customers reach your hosted cancel page — the default Churnkey fallback URL, a branded Churnkey subdomain, or your own custom domain.
- [Appearance](https://docs.churnkey.co/cancel-flows/hosted-cancel-flow/appearance): Brand the hosted cancel page with a color theme, gradient style, and font that match your product — and preview every change live before you save.
- [Cancel Links](https://docs.churnkey.co/cancel-flows/hosted-cancel-flow/cancel-links): Generate signed, single-use URLs from your backend so logged-in customers land directly on their personal cancel-flow page.
- [Email Verification](https://docs.churnkey.co/cancel-flows/hosted-cancel-flow/email-verification): Let any customer reach the hosted cancel page on their own — they enter their email, receive a verification code, and continue without any backend integration on your side.
- [Customer Data Endpoint](https://docs.churnkey.co/cancel-flows/hosted-cancel-flow/customer-data-endpoint): Pass dynamic customer attributes — plan, usage, tenure, support history — to the Hosted Cancel Flow so you can target offers and route based on the customer's full context.
- [Hosted Cancel Flow](https://docs.churnkey.co/cancel-flows/hosted-cancel-flow): Send customers to a Churnkey-hosted cancellation page instead of embedding the JavaScript SDK in your application.
- [Adaptive Offers](https://docs.churnkey.co/cancel-flows/adaptive-offers): AI-powered discount optimization that automatically finds the perfect offer for each customer
- [Boosted Revenue](https://docs.churnkey.co/cancel-flows/analytics/average-boosted-revenue): Measure the long-term value of retained subscribers
- [Save Rate](https://docs.churnkey.co/cancel-flows/analytics/save-rate): The percentage of customers that your Cancel Flows saved from cancellation
- [Reactivation Rate](https://docs.churnkey.co/cancel-flows/analytics/reactivation-rate): The percentage of customers who pay at least one invoice after being saved
- ["Sessions"](https://docs.churnkey.co/cancel-flows/analytics/session-outcomes): "Track each interaction that a customer has with your Cancel Flows"
- [Cancellation Trends](https://docs.churnkey.co/cancel-flows/analytics/cancellation-trends): Analyze and interpret the selection rates and trends for cancellation reasons in your Cancel Flows.
- [Feedback AI](https://docs.churnkey.co/cancel-flows/analytics/feedback-ai): Transform customer feedback into actionable insights with AI-powered categorization and analysis
- [Response Flow](https://docs.churnkey.co/cancel-flows/analytics/response-flow): Visualize how customers move from primary cancellation reasons to specific follow-up selections with the Sankey diagram
- [Response Explorer](https://docs.churnkey.co/cancel-flows/analytics/response-explorer): Drill into individual follow-up responses with the Treemap visualization, search, trend analysis, and MRR impact sorting
- [Manual Translations](https://docs.churnkey.co/cancel-flows/multi-language-support): Support multiple languages.
- [Automatic Translations](https://docs.churnkey.co/cancel-flows/multi-language-support/automatic-translation): Enable AI-powered multilingual support for your Cancel Flows with a single toggle.
- [Custom offer types](https://docs.churnkey.co/cancel-flows/offers/custom-offer-types): Define your own offer types in code and let your team configure them in the builder.
- [Discount](https://docs.churnkey.co/cancel-flows/offers/discounts): Offer targeted subscription discounts to reduce churn and increase customer retention
- [Hidden Plans](https://docs.churnkey.co/cancel-flows/offers/hidden-plans): Use the Switch Subscription Plan offer to present exclusive, non-public plans to customers during cancellation
- [Pause Subscription](https://docs.churnkey.co/cancel-flows/offers/pause-subscription): Temporarily suspend subscription payments without canceling the service
- [Rebate](https://docs.churnkey.co/cancel-flows/offers/rebate): Refund part of a paid invoice while keeping the subscription active, for money-back guarantee windows.
- [Switch Subscription Plan](https://docs.churnkey.co/cancel-flows/offers/switch-subscription): Allow customers to change to a different subscription plan during the cancellation flow to retain them with a more suitable option
- [Trial Extension](https://docs.churnkey.co/cancel-flows/offers/trial-extension): Extend customer trial periods to reduce churn and increase conversion rates during the critical trial-to-paid transition

## Payment Recovery

- [Getting Started](https://docs.churnkey.co/failed-payment-recovery/payment-recovery): Recover failed payment revenue, automatically.
- [Campaign Templates](https://docs.churnkey.co/failed-payment-recovery/campaign-templates): Launch Payment Recovery campaigns from recommended scenarios so audience, cadence, and starter copy are ready in a couple of clicks.
- [Customize your Campaigns](https://docs.churnkey.co/failed-payment-recovery/campaign-customization): Customize your Payment Recovery Campaigns to match the unique needs of your individual customers.
- [Failed Payment Wall](https://docs.churnkey.co/failed-payment-recovery/failed-payment-wall): Block access to your application when payments fail
- [Billing Contact API](https://docs.churnkey.co/failed-payment-recovery/billing-contact-api): Send Payment Recovery emails to multiple billing contacts
- [A/B Testing](https://docs.churnkey.co/failed-payment-recovery/ab-testing): Optimize your payment recovery campaigns through controlled experiments that maximize revenue recovery.
- [Overall Performance](https://docs.churnkey.co/failed-payment-recovery/analytics/overview): Key performance metrics for your Payment Recovery campaigns

## Reactivations

- [Getting Started](https://docs.churnkey.co/reactivations): Churnkey helps you to recover unsubscribed customers with easy, customizable Reactivation Email Campaigns.
- [Customization](https://docs.churnkey.co/reactivations/campaign-customization-guide): Customize your Reactivation Campaigns to match the individual needs of your customers.

## Customer Health

- [Customer Health](https://docs.churnkey.co/customer-health): Identify which of your customers are happy, which aren’t, and begin the process of proactive retention.

## Data Integrations

- [Data API](https://docs.churnkey.co/data-integrations/data-api): Access your data through our API.
- [Slack notifications](https://docs.churnkey.co/data-integrations/slack): Connect Churnkey with your organization's Slack and to send session notifications to a specific channel.
- [Webhooks](https://docs.churnkey.co/data-integrations/webhooks): Churnkey can send webhooks to automatically notify your application whenever a customer completes a session.
- [Event Tracking](https://docs.churnkey.co/data-integrations/event-tracking): Track your customers' key-value metrics on a per customer basis.
- [Passive Data Collection](https://docs.churnkey.co/data-integrations/passive-collection): If you already have the Churnkey embed installed, Churnkey can activate passive collection for your organization without code changes.
- [MCP Server](https://docs.churnkey.co/data-integrations/mcp): Connect Claude, Cursor, and other AI agents to your Churnkey data.

## Billing Providers

- [Payment Providers](https://docs.churnkey.co/billing-providers/payment-provider-overview): Feature support for Stripe, Chargebee, Paddle, and Braintree
- [Stripe](https://docs.churnkey.co/billing-providers/stripe): Integrate Churnkey with your Stripe account
- [Chargebee](https://docs.churnkey.co/billing-providers/chargebee): Integrate Churnkey with your Chargebee account
- [Paddle Classic](https://docs.churnkey.co/billing-providers/paddle-classic): Integrate Churnkey with your Paddle Classic account
- [Paddle Billing](https://docs.churnkey.co/billing-providers/paddle-billing): Integrate Churnkey with your Paddle Billing account
- [Braintree](https://docs.churnkey.co/billing-providers/braintree): Integrate Churnkey with your Braintree account
- [Maxio](https://docs.churnkey.co/billing-providers/maxio): Integrate Churnkey with your Maxio (formerly Chargify) account
- [Churnkey Direct](https://docs.churnkey.co/billing-providers/direct-connect/direct): Integrate Churnkey with any billing system using Direct mode
- [Direct Mode Examples](https://docs.churnkey.co/billing-providers/direct-connect/direct-examples): Real-world examples for common subscription scenarios

## Account

- [Multi-Workspace Support](https://docs.churnkey.co/account/multi-workspace-support): Use one email address to access multiple Churnkey workspaces and switch between them instantly.
- [Roles and Permissions](https://docs.churnkey.co/account/roles-and-permissions): Who can do what in your Churnkey workspace.
- [Activity Log](https://docs.churnkey.co/account/activity): The workspace audit trail — who changed what, and when, including AI-agent actions.

## Support

- [Frequently Asked Questions](https://docs.churnkey.co/support/faqs): We want setting up Churnkey to be a breeze.

## Integrations

- [Integration Basics](https://docs.churnkey.co/integrations/general): Learn the core concepts and requirements for building a Churnkey integration.
- [Custom Provider Integration](https://docs.churnkey.co/integrations): Build a custom integration to connect your billing system with Churnkey's retention tools.
- [Customer Model](https://docs.churnkey.co/integrations/models/customer): A customer is a user who is being billed for a subscription. This model includes information about the customer, such as their name, email, address, etc.
- [Price Model](https://docs.churnkey.co/integrations/models/price): A price (also known as plan) defines the cost, currency and billing cycle of product or service.
- [Subscription Model](https://docs.churnkey.co/integrations/models/subscription): A subscription is a recurring payment for a product or service. This model includes information about the subscription, including its status, billing cycle, items, and discounts.
- [Coupon Model](https://docs.churnkey.co/integrations/models/coupon): Coupon represents a code that can be redeemed for a discount.
- [Product Model](https://docs.churnkey.co/integrations/models/product): Product represents a good or service that can be sold.
- [Family Model](https://docs.churnkey.co/integrations/models/family): A group of products or services.
- [Customers - Controller](https://docs.churnkey.co/integrations/controllers/customers): List, retrieve and find `Customer` models.
- [Prices - Controller](https://docs.churnkey.co/integrations/controllers/prices): List and retrieve `Price` models.
- [Subscriptions - Controller](https://docs.churnkey.co/integrations/controllers/subscriptions): List and retrieve `Subscription` models.
- [Coupons - Controller](https://docs.churnkey.co/integrations/controllers/coupons): List and retrieve `Coupon` models.
- [Products - Controller](https://docs.churnkey.co/integrations/controllers/products): List and retrieve `Product` models.
- [Families - Controller](https://docs.churnkey.co/integrations/controllers/families): List and retrieve `Family` models.
- [Cancel - Action](https://docs.churnkey.co/integrations/actions/cancel): Cancels a subscription at specific date.
- [Pause - Action](https://docs.churnkey.co/integrations/actions/pause): Pauses a subscription at specific date for a specific period.
- [Extend Trial - Action](https://docs.churnkey.co/integrations/actions/extend-trial): Extends a subscription trial period for a specific duration.
- [Apply Coupon](https://docs.churnkey.co/integrations/actions/apply-coupon): Apply a coupon to a subscription.
- [Change Price - Action](https://docs.churnkey.co/integrations/actions/change-price): Changes the price and/or product of a subscription.
- [Publish your Integration](https://docs.churnkey.co/integrations/publish): Learn how to make your integration available to Churnkey.