Command reference

Use the Paid CLI to manage Paid resources from your terminal.

Install

$
npm install -g @paid-ai/cli

Authentication

paid init

Save a Paid API key for this machine. Opens the API keys page, prompts for a key, and sets the active profile.

$
paid init

By default, init creates a sandbox profile labelled Sandbox.

$
paid init --api-key paid_xxx

paid env

Show the active profile and API URL.

$
paid env

Select a profile for one command:

$
paid --env production env

paid env switch

Switch the active environment profile.

$
paid env switch production

Resources

paid product

Create, list, retrieve, and update products.

$
paid product list

paid customer

Create, list, retrieve, update, and delete customers. Retrieve credit balances and upsert customer users.

$
paid customer list

paid contact

Create, list, retrieve, update, and delete customer contacts.

$
paid contact list

paid order

Create, activate, list, retrieve, update, and delete orders. List order lines, manage order seats and seat assignments.

$
paid order list

paid invoice

List invoices, retrieve an invoice, update an invoice, and list invoice lines.

$
paid invoice list

paid signal

Send signals in bulk.

$
paid signal create-bulk --file ./signals.json

paid checkout

Create, list, retrieve, and archive checkout links.

$
paid checkout list

paid credit

List credit currencies.

$
paid credit currencies

paid customer-portal

Create customer portal sessions.

$
paid customer-portal create --file ./portal.json

paid value-receipt

Sync, list, retrieve, refresh, seal, archive, unarchive, publish, and unpublish value receipts.

$
paid value-receipt list

paid pricing

List, retrieve, and update pricing configurations.

$
paid pricing list

paid cost

Ingest costs.

$
paid cost create-bulk --file ./costs.json

paid webhook

List, update, and test webhooks.

$
paid webhook list

Request Bodies

Commands that accept JSON bodies support three input styles.

Shorthand fields

Pass fields directly as key=value pairs.

$
paid customer create name="Acme Corp" externalId=acme

--file

Read JSON from a file.

$
paid customer create --file ./customer.json

--stdin

Read JSON from stdin.

$
cat customer.json | paid customer create --stdin

Global Options

Global options can be used with any command.

$
paid product list --api-key paid_xxx --timeout-ms 30000

Environment Variables