Installation
Homebrew (macOS/Linux)
Authentication
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
Customers
Subscriptions
active, trialing, paused, past_due, expired, canceled, scheduled_cancel
Checkouts
Transactions
Configuration
Interactive Mode
Run a resource command without a subcommand to launch an interactive browser:- Arrow keys to navigate
- Enter to view details
:to open the command barqto 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
Generate bulk checkout links
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:- Complete account verification in the Dashboard β Balances β Payout Account
- Switch to your live API key:
Next Steps
Store Monitoring
Set up automated monitoring to get notified about sales and issues
Webhooks
Handle real-time payment events in your application