Skip to main content
The Creem CLI lets you manage products, customers, subscriptions, and transactions directly from the terminal. It’s designed for both human developers and AI agents building automation workflows.

Installation

Homebrew (macOS/Linux)

Verify installation:

Authentication

API Key Security: Never share your API key with any service, tool, or agent other than the Creem CLI or API. Keys are stored locally at ~/.creem/config.json.

Test vs Live Mode

The CLI automatically detects your environment based on the API key prefix: Always start in test mode. Switch to live only when you’re ready for real transactions.

Command Reference

Products

Product Options:

Customers

Subscriptions

Subscription Statuses: active, trialing, paused, past_due, expired, canceled, scheduled_cancel
Best Practice: Use --mode scheduled for cancellations. Immediate cancellation cuts off access instantly, which frustrates customers.

Checkouts

Transactions

Configuration

Interactive Mode

Run a resource command without a subcommand to launch an interactive browser:
Keys:
  • Arrow keys to navigate
  • Enter to view details
  • : to open the command bar
  • q to exit

Output Formats

Every command supports table (default) and JSON output:
For AI Agents: Always use --json and parse with jq for reliable automation:

Automation Examples

Check for new transactions

Count active subscriptions

Check for payment issues

Daily subscription health check

Tips for AI Agents

Use JSON Output

Always add --json to commands when processing output programmatically. Parse with jq for reliable automation.

Test Mode First

Mistakes in live mode affect real customers and money. Always develop against test mode.

Check whoami First

Run creem whoami before operations to confirm authentication and environment.

Don't Guess IDs

List resources first, then use actual IDs from the response. Don’t assume ID formats.

Going Live

Before accepting real payments:
  1. Complete account verification in the Dashboard β†’ Balances β†’ Payout Account
  2. Switch to your live API key:
The CLI automatically switches to the production API based on the key prefix.

Next Steps

Store Monitoring

Set up automated monitoring to get notified about sales and issues

Webhooks

Handle real-time payment events in your application