Skip to navigation

Quickstart

The Paid CLI is a command line interface for the Paid API.

Prerequisites

  • Node.js and npm available on your machine.
  • A Paid API key.

Install

npm install -g @paid-ai/cli

Authenticate

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

paid init

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

You can also pass the key directly:

paid init --api-key paid_xxx

Check Your Environment

Show the active profile and API URL:

paid env

Add or switch profiles by running init with --env:

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

Common Options

paid product list \
--api-key paid_xxx \
--base-url https://api.agentpaid.io/api/v2 \
--timeout-ms 30000
  • --api-key overrides PAID_API_KEY and saved config.
  • --base-url overrides the API URL for the request.
  • --env selects a saved profile.
  • --timeout-ms sets the HTTP timeout.