CLI reference

The Stigg CLI is currently in public beta. Feedback and bug reports are welcome.

Commands, flags, and common workflows for the Stigg CLI. To install and authenticate, see Get started with the CLI.

Common commands

Read operations

stigg v1:customers list

List all customers in the current environment

stigg v1:customers retrieve

Get details for a specific customer

stigg v1:subscriptions list

List subscriptions, optionally filtered by customer

stigg v1:subscriptions retrieve

Get full details for a subscription

stigg v1:entitlements check

Check a customer’s access to a specific feature

stigg v1:plans list

List all plans in the product catalog Write operations

stigg v1:customers provision

Create or update a customer record

stigg v1:subscriptions provision

Subscribe a customer to a plan

stigg v1:subscriptions update

Update an existing subscription (e.g. add-on quantities)

stigg v1:subscriptions cancel

Cancel a subscription immediately or at period end

stigg v1:usage report

Report metered feature usage for a customer

stigg v1:events report

Submit a raw usage event for aggregation Run stigg --help for the full command reference, or stigg v1:<resource> --help for flags on a specific resource.

Example use-cases

Debug a customer issue Check what a customer is entitled to and whether their subscription is active, without opening the Stigg console:

stigg v1:customers retrieve --id cust-001
stigg v1:subscriptions list --customer-id cust-001
stigg v1:entitlements check --customer-id cust-001 --feature-id feature-api-calls

Seed a sandbox for local development Provision a test customer and subscription in one shot:

stigg v1:customers provision --customer-id cust-test-001 --email dev@example.com --name "Test User"
stigg v1:subscriptions provision --customer-id cust-test-001 --plan-id plan-pro

Automate in CI/CD Store your API key as a secret in your CI/CD system and inject it as STIGG_API_KEY at runtime. For example, provision test fixtures before integration tests run, then tear them down after:

# Setup
export STIGG_API_KEY=$STIGG_SANDBOX_KEY
stigg v1:customers provision --customer-id cust-ci-$BUILD_ID --email ci@example.com
stigg v1:subscriptions provision --customer-id cust-ci-$BUILD_ID --plan-id plan-starter

# ... run tests ...

# Teardown
stigg v1:subscriptions cancel --customer-id cust-ci-$BUILD_ID --cancellation-date IMMEDIATE

Report usage from a script Push metered usage from a batch job or cron task:

stigg v1:usage report --customer-id cust-001 --feature-id feature-api-calls --value 150

Global flags

Flag	Description
`--api-key`	Stigg API key (overrides `STIGG_API_KEY`)
`--help`	Show command usage
`--debug`	Enable debug logging, including HTTP request/response details
`--version`, `-v`	Show the CLI version
`--base-url`	Use a custom API backend URL
`--format`	Output format: `auto`, `explore`, `json`, `jsonl`, `pretty`, `raw`, `yaml`
`--format-error`	Output format for errors: `auto`, `explore`, `json`, `jsonl`, `pretty`, `raw`, `yaml`
`--transform`	Transform output using GJSON syntax
`--transform-error`	Transform error output using GJSON syntax

CLI vs MCP server

Not sure which tool to use? See the side-by-side comparison.

Get started

Essentials

SDK reference

SDK documentation

Subscriptions

Bulk Import

Usage

Coupons

Products

Features

Addons

Plans

Promotional Entitlements

Customers

Customer Integrations

Data Export

Entitlements

Plan Entitlements

Addon Entitlements

Credit grants

Credit consumption

Credit usage

Auto recharge

Custom currencies

Credit ledger

Contracts

Invoices

Governance Entity Types

Governance Entities

Governance Assignments

Governance Hierarchy

Governance Entitlements Check

CLI reference

Common commands

Example use-cases

Global flags

CLI vs MCP server

​Common commands

​Example use-cases

​Global flags

CLI vs MCP server

Common commands

Example use-cases

Global flags