CreditKit Pro documentation
This is the documentation for CreditKit Pro 2.2.0, the store-credit plugin for WooCommerce. Twelve pages sit in four groups: install and activate, run the store, developer interfaces, and reference. Every number on these pages was read out of the shipped plugin code rather than carried over from an earlier release, so the counts match what a 2.2.0 install actually does.
Start with the getting-started guide if CreditKit Pro is not installed yet, or the settings reference if it is.
Install and activate
- Getting started — WooCommerce ships no per-customer credit balance, and this page explains what CreditKit Pro adds and the five steps from activation to a first credit-paid order.
- Installation — the upload and activation path, the PHP 8.1 floor that WordPress enforces before the Activate link works, and the 15 database tables activation creates.
- Licence activation — where the CK licence key goes, what the 12-hour validation cache does, and what changes on the day a licence expires.
Run the store
- Settings reference — every option on the seven Settings tabs: General, Features, Purchase Options, Display, Rewards, Advanced and Shortcodes.
- Refunds and credits — CreditKit Pro has three separate refund mechanisms, and only the goodwill-issuance one uses the configurable money-to-credits rate.
- Groups and budgets — the optional B2B module covering teams, shared credit budgets, manager approvals, recurring member allowances, a per-team bundle discount and team reporting. The module ships switched off.
The per-team bundle discount is the only discount the teams module applies as of 2.2.0. The older volume-discount tiers were retired on the team purchase path when team budgets moved from money to credits.
Developer interfaces
- REST API — 20 routes under the
pcs/v1namespace, carrying 27 method handlers between them, authenticated with an API key. - Webhooks — 18 event types signed with HMAC-SHA256, delivered in the background, and retried on a fixed ladder up to five attempts before the endpoint is disabled.
- HPOS and Checkout Blocks — CreditKit Pro declares compatibility with High-Performance Order Storage and with the Cart and Checkout Blocks, with nothing to configure on either.
A nineteenth webhook event, badge.earned, is registered only while the Rewards gamification toggle is on, and that toggle ships off. One of the 18 events, webhook.test, is the internal test ping and is hidden from the admin subscription form, which leaves 17 events a merchant can subscribe to.
Reference and help
- Fraud scoring — a five-factor weighted score from 0 to 100, scaled by one of three security presets, with two enforced thresholds: high at 75 flags a transaction and critical at 90 blocks it.
- Troubleshooting — the failure modes support sees most often, with the screen or the WP-Cron job that fixes each one.
- FAQ — pre-purchase questions about coupons, gift cards, tax treatment and what CreditKit Pro does not do.
The published fraud thresholds of 75 and 90 are baselines. The Security preset multiplies both: the low preset raises them by a factor of 1.3, the balanced preset leaves them alone, and the high preset lowers them by a factor of 0.7. Two further values named in older documentation, a low threshold of 25 and a medium threshold of 50, are stored but read by nothing in 2.2.0.
Which page answers which question
| Question | Page |
|---|---|
| Does WooCommerce have store credit? | Getting started |
| How do I refund a WooCommerce order to store credit? | Refunds and credits |
| Can a company give staff a shared credit budget? | Groups and budgets |
| Does the plugin work with HPOS and the block checkout? | HPOS and Checkout Blocks |
| How do I read a customer balance from another system? | REST API |
| How do I get notified when a balance changes? | Webhooks |