Creem CLI

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

Prerequisite: Node.js 22 or newer.

brew tap armitage-labs/creem
brew install creem

npm install -g @creem_io/cli

npx @creem_io/cli --help

After installing, run creem --version to check your version and creem --help to explore commands. With npx, replace creem with npx @creem_io/cli in the examples below.

Authentication

Run creem login for a masked local prompt. For automation, set CREEM_API_KEY using your CI secret store or shell environment, then run:

creem whoami --json
creem products list --json

Environment keys take precedence over stored credentials and are never written to disk. The key determines test/live mode. --environment test|live must match it. Local login writes ~/.creem/config.json with mode 0600 in a 0700 directory. creem logout clears stored credentials; an environment key remains active.

Configuration

Inspect your saved settings or choose a default output format:

creem config show
creem config set output_format json
creem config set output_format table

Configuration output redacts the stored API key. Use creem login to change credentials; switching between test and live requires a matching API key. Pass --json or --output table|json|ndjson to override the saved output format for a command.

Interactive browsing

Run a resource command without a subcommand to browse your store:

creem products
creem customers
creem subscriptions
creem transactions

Search records, open details, and manage subscriptions from the terminal. See the interactive guide for navigation and examples.

Command reference

Use --help on any command to see its accepted flags. credits, cust, subs, and txn are aliases. IDs are positional where shown. Authentication, configuration, and migrate lemon-squeezy are also available.

Command	Inputs
`creem products list`	`--page`, `--limit`, `--status`, `--all`
`creem products create`	`--idempotency-key`, `--name`, `--description`, `--price`, `--currency`, `--billing-type`, `--billing-period`, `--recurring-interval`, `--recurring-interval-count`, `--tax-mode`, `--tax-category`, `--pay-what-you-want`, `--suggested-price`, `--success-url`, `--custom-field`, `--abandoned-cart-recovery`, `--image-url`, `--data`
`creem products get`	`<id>`
`creem products update`	`<id>`, `--name`, `--description`, `--success-url`, `--price`, `--currency`, `--billing-type`, `--billing-period`, `--recurring-interval`, `--recurring-interval-count`, `--tax-mode`, `--pay-what-you-want`, `--suggested-price`, `--image-url`, `--data`, `--yes`
`creem products archive`	`<id>`, `--yes`
`creem customers list`	`--page`, `--limit`, `--all`
`creem customers orders`	`<id>`, `--page`, `--limit`, `--all`
`creem customers subscriptions`	`<id>`, `--page`, `--limit`, `--all`
`creem customers licenses`	`<id>`, `--page`, `--limit`, `--all`
`creem customers get`	`[id]`, `--email`
`creem customers create`	`--email`, `--name`, `--metadata`, `--external-id`, `--data`
`creem customers update`	`<id>`, `--name`, `--metadata`, `--external-id`, `--data`, `--yes`
`creem customers billing`	`<id>`, `--data`
`creem subscriptions get`	`<id>`
`creem subscriptions list`	`--page`, `--limit`, `--all`
`creem subscriptions cancel`	`<id>`, `--mode`, `--on-execute`, `--data`, `--yes`
`creem subscriptions update`	`<id>`, `--item`, `--update-behavior`, `--data`, `--yes`
`creem subscriptions upgrade`	`<id>`, `--product`, `--update-behavior`, `--data`, `--yes`
`creem subscriptions pause`	`<id>`, `--yes`
`creem subscriptions resume`	`<id>`
`creem checkouts get`	`<id>`
`creem checkouts create`	`--request-id`, `--product`, `--units`, `--custom-price`, `--discount`, `--affiliate-code`, `--customer`, `--custom-field`, `--success-url`, `--metadata`, `--customer-email`, `--data`
`creem licenses activate`	`--key`, `--instance-name`, `--data`
`creem licenses deactivate`	`--key`, `--instance-id`, `--data`, `--yes`
`creem licenses validate`	`--key`, `--instance-id`, `--data`
`creem licenses instances`	`<id>`, `--page`, `--limit`, `--all`
`creem discounts list`	`--page`, `--limit`, `--product`, `--status`, `--type`, `--created-after`, `--created-before`, `--all`
`creem discounts get`	`[id]`, `--code`
`creem discounts create`	`--name`, `--code`, `--type`, `--amount`, `--currency`, `--percentage`, `--expires`, `--max-redemptions`, `--duration`, `--duration-months`, `--products`, `--data`
`creem discounts delete`	`<id>`, `--yes`
`creem transactions get`	`<id>`
`creem transactions list`	`--customer`, `--order`, `--product`, `--page`, `--limit`, `--all`
`creem stats summary`	`--start-date`, `--end-date`, `--interval`, `--currency`
`creem moderation screen`	`--prompt`, `--external-id`, `--data`
`creem transactions refund`	`<id>`, `--data`, `--yes`
`creem customer-credits create`	`--name`, `--customer`, `--unit-label`, `--initial-balance`, `--data`
`creem customer-credits list`	`--limit`, `--customer`, `--starting-after`, `--ending-before`, `--all`
`creem customer-credits get`	`<id>`
`creem customer-credits balance`	`<id>`, `--at`
`creem customer-credits entries`	`<id>`, `--limit`, `--starting-after`, `--ending-before`, `--all`
`creem customer-credits freeze`	`<id>`, `--yes`
`creem customer-credits unfreeze`	`<id>`
`creem customer-credits credit`	`<id>`, `--amount`, `--reference`, `--idempotency-key`, `--data`
`creem customer-credits debit`	`<id>`, `--amount`, `--reference`, `--idempotency-key`, `--data`, `--yes`
`creem customer-credits reverse`	`<id>`, `--transaction`, `--data`, `--yes`
`creem customer-credits close`	`<id>`, `--yes`
`creem customer-credits transactions create`	`--reference`, `--idempotency-key`, `--entry`, `--data`, `--yes`
`creem customer-credits transactions get`	`<id>`
`creem customer-credits transactions reverse`	`<id>`, `--yes`
`creem customer-credits transactions list`	`--reference`
`creem affiliates invites create`	`--email`, `--name`, `--program`, `--data`
`creem affiliates invites list`	`--page`, `--limit`, `--all`
`creem affiliates list`	`--page`, `--limit`, `--all`
`creem affiliates get`	`<id>`
`creem affiliates commissions`	`<id>`, `--status`, `--page`, `--limit`, `--all`
`creem splits create`	`--description`, `--type`, `--type-reference`, `--recipient`, `--data`
`creem splits list`	`--page`, `--limit`, `--all`
`creem splits get`	`<id>`
`creem splits delete`	`<id>`, `--yes`
`creem events ingest`	`--events`, `--data`
`creem events preview`	`--events`, `--data`
`creem events list`	`--meter`, `--customer`, `--reference`, `--limit`, `--starting-after`, `--all`
`creem meters create`	`--name`, `--event-name`, `--aggregation`, `--aggregation-property`, `--filter`, `--unit-label`, `--data`
`creem meters list`	`--limit`, `--starting-after`, `--ending-before`, `--include-archived`, `--all`
`creem meters preview`	`--event-name`, `--aggregation`, `--aggregation-property`, `--filter`, `--unit-label`, `--data`
`creem meters get`	`<id>`
`creem meters update`	`<id>`, `--name`, `--aggregation`, `--aggregation-property`, `--filter`, `--data`, `--yes`
`creem meters preview-stored`	`<id>`
`creem meters consumed`	`<id>`, `--customer`, `--at`
`creem meters archive`	`<id>`, `--yes`
`creem meters unarchive`	`<id>`

Request bodies

Every operation with a body supports --data with camelCase field names. Choose body flags or --data; mixing them is rejected. Path IDs and header/query flags remain available with --data.

creem checkouts create --product prod_123 --units 2 --customer-email person@example.com --json
creem products create --data @product.json --idempotency-key import-1 --json
cat customer.json | creem customers update cust_123 --data - --yes --json

Repeat --metadata key=value for string metadata (last duplicate wins). Use --data for numeric or nested metadata. Repeat --custom-field, --item, or --recipient with JSON objects, and --image-url with ordered URLs. Credit amounts are strings and retain full precision. Free products accept --price 0. Custom billing accepts --billing-period custom with both recurring interval flags. Use customFields instead of the deprecated customField.

Pagination and automation

Global flags work before or after commands: --json, --output table|json|ndjson, --no-color, --timeout <ms>, --environment, and --yes. The default timeout is 30000 ms. Numbered lists accept --page and --limit; credit lists use --starting-after or --ending-before. --all traverses from the supplied page/cursor. NDJSON streams one item per line without buffering the entire collection.

creem subscriptions list --all --json
creem credits entries acc_123 --limit 100 --all --output ndjson

Single-page JSON returns the result without transport fields. --all --json aggregates results and recomputes totals. The legacy subscription --status filter traverses every page, rejects --page/--limit, and labels the output with filter.scope: "client" and a recomputed totalRecords.

Errors and safety

Result data goes to stdout. JSON errors go to stderr as { "error": { "type", "message", "status", "traceId", "details", "cause", "suggestion", "retryAfter" } }. Exit codes are 0 success, 1 unexpected, 2 usage/validation, 3 auth/config, 4 API response, and 5 network/timeout. A late NDJSON failure can leave earlier records on stdout; always check the exit code. Destructive operations require a TEST/LIVE confirmation in a terminal or --yes in noninteractive/JSON/NDJSON mode. This includes updates, upgrades, refunds, immediate/default cancellation, pause, archive/delete, license deactivation, credit freeze/debit/reverse/close, and posting or reversing credit transactions. Scheduled cancellation does not prompt. No writes are automatically retried; check ambiguous outcomes before retrying manually. Human output masks license keys; successful JSON retains the full response.

Upgrading existing scripts

subscriptions list now lists subscriptions directly instead of deriving them from transactions; the old transaction-derived note field is removed. discounts list now supports search filters and pagination. Scripts invoking destructive actions must supply --yes. See the agent workflow or interactive guide for your preferred interface.

Get Started

AI

Features

Code

Integrations

Community

Merchant of Record

For Customers

Installation

Authentication

Configuration

Interactive browsing

Command reference

Request bodies

Errors and safety

Upgrading existing scripts

​Installation

​Authentication

​Configuration

​Interactive browsing

​Command reference

​Request bodies

​Pagination and automation

​Errors and safety

​Upgrading existing scripts

Installation

Authentication

Configuration

Interactive browsing

Command reference

Request bodies

Pagination and automation

Errors and safety

Upgrading existing scripts