Pay

agenta pay wraps the same checkout flow as the @agentaos/pay SDK and the dashboard: create a checkout, get back its checkout URL, and track its status from the terminal. Use it for one-off invoicing, quick testing, and scripts that create payments.

agenta pay commands authenticate with your agenta login session, not an API key. For key-based auth in a backend or script, use @agentaos/pay or the REST API with an sk_live_/sk_test_ key instead.

Create a checkout

agenta pay checkout -a <amount> [-c <currency>] [-d <description>] [--email <email>] [--json]

number

required

Payment amount in currency units, e.g. -a 49.99 for €49.99. Not cents.

string

default:"org default"

Currency code, e.g. EUR, USD.

string

Shown to the buyer on the checkout page.

string

Pre-fills the buyer’s email on the checkout page.

boolean

Output a single JSON object instead of the human-readable summary.

agenta pay checkout -a 49.99 -c EUR -d "Consulting fee, August"

Output

  Session Id: mZrESFyR7RC9RPsJfZCVkg
  Status: open
  Amount: 49.99
  Currency: EUR
  Checkout Url: https://app.agentaos.ai/checkout/mZrESFyR7RC9RPsJfZCVkg
  Expires At: 2026-08-06T15:32:00.000Z
  Hint: Share the checkoutUrl with your customer.
✓ Checkout created

`--json`

{
  "sessionId": "mZrESFyR7RC9RPsJfZCVkg",
  "status": "open",
  "amount": 49.99,
  "currency": "EUR",
  "checkoutUrl": "https://app.agentaos.ai/checkout/mZrESFyR7RC9RPsJfZCVkg",
  "expiresAt": "2026-08-06T15:32:00.000Z",
  "hint": "Share the checkoutUrl with your customer."
}

Checkouts expire in 30 minutes by default. Share the checkoutUrl with your buyer.

Get a checkout

agenta pay get <sessionId> [--json]

string

required

The checkout session ID, e.g. mZrESFyR7RC9RPsJfZCVkg.

boolean

Output a single JSON object instead of the human-readable summary.

agenta pay get mZrESFyR7RC9RPsJfZCVkg

--json

{
  "sessionId": "mZrESFyR7RC9RPsJfZCVkg",
  "status": "completed",
  "amount": 49.99,
  "currency": "EUR",
  "checkoutUrl": "https://app.agentaos.ai/checkout/mZrESFyR7RC9RPsJfZCVkg",
  "expiresAt": "2026-08-06T15:32:00.000Z",
  "createdAt": "2026-08-06T15:02:00.000Z"
}

amount here reflects a per-checkout override and can be null if this checkout used its product’s own amount rather than overriding it. status is one of open, completed, expired, cancelled.

List checkouts

agenta pay list [--status <status>] [--limit <n>] [--json]

string

Filter by open, completed, expired, or cancelled. Omit to list all.

number

default:"10"

Results per page, 1 to 100.

boolean

Output a single JSON object instead of a table.

agenta pay list --status completed --limit 5

Output

  Checkouts (14 total)

  completed   49.99    EUR    mZrESFyR7RC9RPsJfZCVkg   Consulting fee, August
  completed   199.00   USD    Oz1cpiHki8gAawFAHgYh1w   Annual plan renewal
  open        49.99    EUR    lLd0Kl04lC3hvPH_7AQ20A

  3 of 14 shown.

`--json`

{
  "total": 14,
  "hasMore": true,
  "items": [
    {
      "sessionId": "mZrESFyR7RC9RPsJfZCVkg",
      "status": "completed",
      "currency": "EUR",
      "amount": 49.99,
      "description": "Consulting fee, August",
      "checkoutUrl": "https://app.agentaos.ai/checkout/mZrESFyR7RC9RPsJfZCVkg",
      "expiresAt": "2026-08-06T15:32:00.000Z"
    }
  ]
}

Every agenta pay command supports --json, and JSON output kicks in automatically whenever stdout isn’t a terminal. Pipe to jq or a file without the flag: agenta pay list --status open | jq '.items[].checkoutUrl'.

Next steps

Subscriptions

List and cancel recurring subscribers.

Invoices

Pull receipts once a checkout is paid.

Checkouts (SDK)

Create checkouts from your own backend.

Checkouts (concept)

How checkouts, products, and settlement fit together.

SDK

CLI

API Reference

Create a checkout

`--json`

Get a checkout

List checkouts

`--json`

Next steps

Subscriptions

Invoices

Checkouts (SDK)

Checkouts (concept)

​Create a checkout

​--json

​Get a checkout

​List checkouts

​--json

​Next steps

Subscriptions

Invoices

Checkouts (SDK)

Checkouts (concept)

Create a checkout

`--json`

Get a checkout

List checkouts

`--json`

Next steps