Paid CLI

Command line interface for the Paid API.

Install

npm install -g @paid-ai/cli

Authenticate

Create an API key from the Paid app, then initialize the CLI:

paid init

By default, init creates a sandbox profile labelled Sandbox and makes it active.

You can also pass the key directly:

paid init --api-key paid_xxx

Agent Skill

Install the Paid agent skill directly from the skills repository:

npx skills add paid-ai/skills --skill paid-cli

Environment

Show the active profile and API URL:

paid env

Create or update another profile:

paid init --env production --env-type Production --api-key paid_xxx

Switch the active profile:

paid env switch production

Select a saved profile for one command:

paid --env production product list

Commands

Commands are grouped by resource.

paid product list
paid customer list
paid customer aliases --id cus_abc123
paid customer create-alias --id cus_abc123 alias=crm-child-1
paid customer delete-alias --id cus_abc123 --alias crm-child-1
paid contact list
paid order list
paid invoice list
paid signal create-bulk --file ./signals.json
paid checkout list
paid credit currencies
paid customer-portal create --file ./portal.json
paid value-receipt list
paid pricing list
paid cost create-bulk --file ./costs.json
paid webhook list

Request Bodies

Commands that accept JSON bodies support shorthand fields, files, and stdin:

paid customer create name="Acme Corp" externalId=acme
paid customer create --file ./customer.json
cat customer.json | paid customer create --stdin

Use command help to inspect the generated request body summary and CLI notes before sending a request:

paid pricing update --help

Agents can request an OpenAPI-generated command description:

paid describe pricing update

Options

Global options can be used with any command:

paid product list --api-key paid_xxx --base-url https://api.agentpaid.io/api/v2 --timeout-ms 30000

| Flag | Description | | ------------------- | ------------------------------------- | | --api-key <key> | Use this API key for the command. | | --base-url <url> | Use this API URL for the command. | | --env <name> | Use a saved profile for the command. | | --timeout-ms <ms> | Set the HTTP timeout in milliseconds. | | --help | Show command help. | | --version | Show the CLI version. |

Environment variables are also supported:

| Variable | Description | | ------------------------- | ----------------------------------------------------- | | PAID_API_KEY | API key to use when --api-key is not provided. | | PAID_BASE_URL | API URL to use when --base-url is not provided. | | PAID_ENV | Saved profile name to use. | | PAID_ACTIVE_ENVIRONMENT | Saved profile name to use when PAID_ENV is not set. |