Churnkey

Churnkey SDK

A production-ready cancel flow for React. Open source. Optionally connects to Churnkey for analytics and AI-powered retention.

Packages

Quick start

npm install @churnkey/react

import { CancelFlow } from '@churnkey/react'

import '@churnkey/react/styles.css'

myBilling.applyCoupon(offer.couponId)} handlePause={async (offer) => myBilling.pause({ months: offer.result?.months ?? offer.months })} handleCancel={async () => myBilling.cancel()} onClose={() => setOpen(false)} />

Documentation and resources

• @churnkey/react — full API reference, customization, headless usage, custom step types
• @churnkey/node — createToken and authHash
• @churnkey/mcp — MCP server for Claude / Cursor / Claude Desktop
• Create a free Churnkey account — get an appId for analytics
• churnkey.co — dashboard, hosted embed, AI retention features

Repo layout

sdk/

├── packages/ │ ├── react/ @churnkey/react │ ├── node/ @churnkey/node │ └── mcp/ @churnkey/mcp ├── apps/ │ └── playground/ internal dev playground └── scripts/ release + tooling helpers

Local development

pnpm install

pnpm --filter @churnkey/react build pnpm --filter @churnkey/react test

To work against the playground:

pnpm --filter @churnkey/react dev    # rebuilds on change

pnpm --filter @churnkey/playground dev # runs the playground app

Releasing

A merge to main that raises a package's package.json version publishes it. In the PR:

1. Bump version in the package's package.json.
2. Move the Unreleased entries in its CHANGELOG.md under a ## - heading. That section becomes the GitHub release notes.
3. Move the copies of the version kept in code: server.json and src/server.ts for @churnkey/mcp, src/index.ts for @churnkey/node. The release plan refuses to run while they disagree with package.json.

On merge, the Release workflow checks out the commit that set the version (the merge or squash commit on main; rebase merging is off for this reason), runs the CI gate, publishes that build to npm with provenance, tags it @ and creates the GitHub release. For @churnkey/mcp it then runs the registry publish. A merge that does not change a version publishes nothing. Prereleases and versions below the current latest are left alone; publish those by hand with --tag.

A release that stops partway is finished by running the Release workflow again from main: the plan picks up any package whose npm version, tag or release is missing and skips the parts that already landed. Manual runs from other branches do nothing.

Publishing authenticates with npm trusted publishing, so there is no npm token in this repo. Each package lists this repo's release.yml with the release environment as its trusted publisher in its settings on npmjs.com. That environment only deploys from main.

License

MIT