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.

Setup

Provide CREEM_API_KEY through your environment or secret store. The CLI infers test/live mode without persisting the key. Use Node.js 22 or newer for npm, or see the installation guide for Homebrew and npx.

npm install -g @creem_io/cli
creem products list --json
creem subscriptions list --all --json
creem credits entries acc_123 --all --output ndjson

Input contract

Use creem <resource> <command> --help to discover inputs. The command reference lists available commands and flags. Every body operation accepts camelCase JSON inline, from @file.json, or from stdin with --data -. Do not combine body flags with --data. Non-body flags, path IDs, and --yes remain allowed.

creem checkouts create --data '{"productId":"prod_123","customer":{"email":"person@example.com"},"metadata":{"visits":42}}' --json
creem credits credit acc_123 --amount '9007199254740993' --reference event-123 --idempotency-key event-123 --json
creem transactions refund tran_123 --yes --json

Credit amounts stay strings. Writes are attempted once; the CLI never retries automatically. If a write fails ambiguously, inspect its outcome before manually retrying with the same supported idempotency key. Product creation supports the idempotency header; credit/debit idempotency keys are body fields.

Output and errors

Use --json for a single result or aggregated collection, and --all --output ndjson to stream list items. Standard output contains results; structured errors go to standard error. NDJSON may contain successful earlier pages before a later failure. Check the process exit code before accepting a completed export.

Exit	Meaning
0	Success
1	Unexpected failure
2	Invalid CLI usage or request input
3	Auth/config failure
4	API or response-validation failure
5	Network/timeout failure

Without credentials, creem products list --json produces no stdout and exits 3 with this stderr:

{
  "error": {
    "type": "auth",
    "message": "Not authenticated.",
    "status": null,
    "traceId": null,
    "details": null,
    "cause": null,
    "suggestion": "Set CREEM_API_KEY or run creem login.",
    "retryAfter": null
  }
}

Local webhooks

creem listen --forward-to <url> --json streams the store’s webhooks to a local server as NDJSON records (listening, event, stopped) and cleans up its temporary endpoint on exit. Use --once to drain pending events in a single run. See the CLI reference.

Confirmation

Use --yes for destructive commands in automation. Human prompts are disabled for JSON/NDJSON and non-TTY execution. The reference lists the policy. Existing aliases remain valid. For existing scripts, see the upgrade notes. Subscription --status filters all pages and labels its client-side result.

Get Started

AI

Features

Code

Integrations

Community

Merchant of Record

For Customers

Setup

Input contract

Output and errors

Local webhooks

Confirmation

​Setup

​Input contract

​Output and errors

​Local webhooks

​Confirmation

Setup

Input contract

Output and errors

Local webhooks

Confirmation