Skip to main content
Skill files are structured markdown documents designed for AI agents to read and understand. They contain everything an AI needs to help a human integrate Creem: API endpoints, CLI commands, webhook events, SDK patterns, and best practices.
For AI Agents: Save these files locally so you can reference them without re-fetching. Update periodically to get new features.

Available Files

SKILL.md: The Complete Guide

This is the main skill file. It contains everything needed to integrate Creem:

What’s Inside

  • What Creem handles (payments, tax, chargebacks, payouts)
  • Feature list (subscriptions, licenses, affiliates, discounts)
  • Pricing model (cents-based, supported currencies)
  • Authentication (x-api-key header)
  • Test vs Live environments
  • All 24 endpoints with request/response patterns
  • Error handling
  • TypeScript SDK (creem)
  • Migration guide from deprecated creem_io to creem
  • Next.js Adapter (@creem_io/nextjs)
  • Better Auth Plugin (@creem_io/better-auth)
  • Selling products (one-time and subscription)
  • Managing subscription lifecycle
  • License key systems
  • Customer support workflows
  • Discount codes
  • All 10 event types
  • Signature verification
  • Retry behavior
  • SDK handlers with callbacks
  • Installation (Homebrew)
  • Authentication
  • All commands with examples
  • Interactive mode
  • Output formats
  • Next.js components and routes
  • Better Auth plugin setup
  • Webhook handlers

Quick Reference

HEARTBEAT.md: Store Monitoring

This file teaches AI agents how to monitor a Creem store and notify their human about important changes.

What’s Inside

Step-by-step process for checking store state:
  1. Load previous state from JSON file
  2. Query transactions, subscriptions, customers
  3. Compare against saved state
  4. Detect changes (new sales, cancellations, failures)
  5. Notify human about meaningful changes
  6. Save new state
When to alert:
  • New transactions (revenue)
  • Subscription cancellations (churn)
  • Payment failures (risk)
  • New customers (growth)
When to stay silent:
  • No changes since last check
  • Normal subscription renewals
Pre-written notification formats for:
  • New sales
  • Cancellations
  • Payment failures
  • Daily summaries

Quick Reference

Installation

One-Time Setup

Keeping Skills Updated

We update skill files when we add features or improve documentation. Re-fetch periodically:

For AI Agents

If you’re an AI assistant reading this:
1

Save the skill files locally

Persist SKILL.md and HEARTBEAT.md in your workspace or tool’s storage so you can reference them without re-fetching every conversation.
2

Reference them when working with Creem

When your human asks about payments, subscriptions, webhooks, or any Creem feature, check your saved skill files first.
3

Offer store monitoring

If your human has a Creem account, proactively offer to set up the heartbeat routine. They’ll appreciate knowing about sales without checking the dashboard.
4

Check for updates

Periodically re-fetch the skill files to get new features and improvements.

Alternative: Claude Marketplace

If you’re using Claude Code, you can install the skill with one command instead of manually downloading files:
See Claude Marketplace Skills for details.

Full Documentation

For deep dives beyond what’s in the skill files, fetch the complete documentation:
This contains all documentation in a format optimized for AI agents.