Custom Provider Integration
Overview
Churnkey helps reduce churn by offering targeted retention experiences when customers try to cancel. This guide walks you through building a custom integration that connects your billing system to Churnkey, enabling features like pause offers, targeted discounts, and plan changes during cancellation flows.
Core Models
Models map your billing system's data to Churnkey's format. Each model represents a key billing concept that Churnkey needs to understand your customers and their subscriptions.
Invoice
An invoice for a subscription.
Data Access Controllers
Controllers provide secure, standardized access to your billing data. Each controller exposes two essential methods:
retrieve(): Fetch a single record by IDlist(): Fetch multiple records with pagination support
Invoices
List and retrieve Invoice models for advanced analytics.
Subscription Actions
Actions enable Churnkey to modify subscriptions based on customer choices during the cancellation flow. Each action handles a specific type of subscription change, like applying a discount or pausing service.
Deploy Your Integration
Finally, you need to make sure that all your Controllers and Actions are accessible from an Internet, have proper authentication and provide Features manifest.
Follow the publishing guide for detailed deployment instructions and troubleshooting tips.