@hyperline/cli

The official command-line interface for Hyperline — the billing platform built for modern SaaS.

Manage your customers, subscriptions, invoices, products, and more directly from your terminal.

Installation

npm install -g @hyperline/cli

Quick start

# Authenticate with your Hyperline account
hyperline login

# List your customers
hyperline customers list

# Create a new customer
hyperline customers create --name "Acme Inc" --currency USD

# Get a specific invoice
hyperline invoices get --id inv_xxxxx

Authentication

Browser login

hyperline login

Opens your browser to securely authenticate with your Hyperline account. Credentials are stored locally in ~/.hyperline/.

hyperline logout

API key

# Via environment variable
export HYPERLINE_API_KEY=sk_test_...

# Or inline
hyperline customers list --api-key sk_test_...

Resources

Manage every part of your billing stack from the CLI:

• Customers — create, update, list, and manage your customer base
• Subscriptions — handle subscription lifecycle, cancellations, and templates
• Invoices — create, list, and manage invoices and transactions
• Products — define and update your product catalog
• Quotes — generate and manage quotes
• Wallets — prepaid wallet management and top-ups
• Coupons & Promotions — create discount coupons and promotion codes
• Webhooks — configure webhook endpoints
• Payments — track and manage payments
• Analytics — access billing metrics
• Exports — export your billing data
• Custom Properties — extend resources with custom fields
• Taxes — view tax rates and configurations
• Invoicing Entities — manage your billing entities

Examples

# Filter invoices by status
hyperline invoices list --status draft --take 10

# Output as JSON for scripting
hyperline customers list --output json

# Pipe to other tools
hyperline customers list --output json | jq '.[].name'

# Use a custom API endpoint
hyperline customers list --base-url https://api.sandbox.hyperline.co

Global options

| Option | Description | |---|---| | --api-key <key> | API key (overrides HYPERLINE_API_KEY) | | --base-url <url> | API base URL (overrides HYPERLINE_API_URL) | | --output <format> | json or text (default: text) | | --help | Show help | | --version | Show version |

Environment variables

| Variable | Description | |---|---| | HYPERLINE_API_KEY | API key for authentication | | HYPERLINE_API_URL | Custom API base URL |

Learn more

• Hyperline Documentation
• API Reference