ChurnKey

Churnkey Integration Details

Churnkey provides customizable churn flows to help you reduce churn and understand why users are leaving.

Billflow now provides an easy to use integration with Churnkey. Bellow are the steps to get started.

Enable on Billing page

Go to the Advanced settings of your customer portal and enable "Use Churnkey"

This will add configurations keys to your embed snippet so values can be dynamically set.

Churnkey installation

You can find the Churnkey installation steps by logging into Churnkey and clicking on "Embed"

Step 1

The Step 1 on Churnkey's installation instructions can be skipped, Billflow takes care of that for you.

Step 2

You need to generate a security hash for Churnkey the same way it is done for billflow, by running a piece of serverside code with your logged-in customer's Stripe ID and a secret key.

Step 3

Step 3 in Churnkey's instructions is where you can grab your appId. You will notice these are the same keys that get generated on your Billflow snippet.

You will see the following configurations added to your Billflow embed snippet.

plugins: {
churnkey: {
appId: "",
customer_id: "",
authHash: "",
mode: "",
}
}

Key

Value

appId

Churnkey App ID. Grab this from Step 3 of the Churnkey Embed instructions.

customer_id

Set to the Stripe customer ID of the logged in user. Eg: cus_K9c72057lXagII

authHash

Set to the authentication hash generated with your Churnkey server-side snippet. This is different that the Billflow hash although the generation steps are very similar.

mode

Set to the Stripe mode you want to be in. Both the Billflow modes and the Churnkey modes map to Stripe Test and Live mode. Normally set this to the same mode as your billing page. Eg: "test" or "live"