For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inGet Paid
DocumentationAPI ReferenceCLI
DocumentationAPI ReferenceCLI
  • CLI
    • Quickstart
    • Command reference
LogoLogo
Log inGet Paid
On this page
  • Install
  • Authenticate
  • Check Your Environment
  • Common Options
CLI

Quickstart

Was this page helpful?

Command reference

Next
Built with

The Paid CLI is a 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, 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.