Services

Services wrap an upstream API (base URL, auth, networks, mode). This page covers create and day-to-day management.

Create

proceeds services create \
  --name "Weather API" \
  --base-url https://weather.example.com \
  --auth-method none \
  --networks base-sepolia \
  --mode testnet \
  --format json

You can also pass a complete JSON body with --file or --data (exclusive with field flags). Nested authConfig needs --file / --data.

Flag	Purpose
`--name`	Display name (required)
`--base-url`	Upstream base URL (required)
`--auth-method`	Upstream auth (`none`, `bearer`, …) (required)
`--networks`	Accepted network; repeat for multiple (required)
`--mode`	`testnet` or `mainnet` (required)
`--description`	Description
`--file` / `--data`	Complete JSON payload (exclusive with field flags)

Example response (trimmed — no payment URLs):

{
  "data": {
    "id": "cmu…",
    "name": "Weather API",
    "description": null,
    "baseUrl": "https://weather.example.com",
    "authMethod": "none",
    "authConfig": null,
    "networks": ["base-sepolia"],
    "mode": "testnet",
    "createdAt": "2026-09-19T02:20:42.796Z",
    "updatedAt": "2026-09-19T02:20:42.796Z"
  }
}

List

proceeds services list --limit 1 --format json

Flag	Default	Notes
`--limit`	`20`	Page size (1–100)
`--offset`	`0`	Records to skip

Example response (trimmed — list also embeds paywall summaries):

{
  "data": [
    {
      "id": "cmu…",
      "name": "CLI Docs Demo",
      "description": "Updated by CLI docs run",
      "baseUrl": "https://httpbin.org",
      "authMethod": "none",
      "networks": ["base-sepolia"],
      "mode": "testnet",
      "Paywall": [
        { "id": "mmmo…", "slug": "cli-docs-flags", "pricingMode": "exact", "price": "10000" }
      ]
    }
  ],
  "meta": {
    "pagination": { "total": 5, "limit": 1, "offset": 0, "hasMore": true }
  }
}

Get

proceeds services get <id> --format json

Example response:

{
  "data": {
    "id": "cmu…",
    "name": "CLI Docs Demo",
    "description": "CLI docs demo",
    "baseUrl": "https://httpbin.org",
    "authMethod": "none",
    "networks": ["base-sepolia"],
    "mode": "testnet"
  }
}

Upstream credentials in the full response are masked.

Update

Partial update — only supply fields you want to change.

proceeds services update <id> --description "CLI docs demo" --format json

Example response (trimmed):

{
  "data": {
    "id": "cmu…",
    "name": "CLI Docs Demo",
    "description": "CLI docs demo",
    "baseUrl": "https://httpbin.org",
    "authMethod": "none",
    "networks": ["base-sepolia"],
    "mode": "testnet",
    "updatedAt": "2026-09-19T07:45:07.697Z"
  }
}

Flag	Purpose
`--name`	Display name
`--description`	Description
`--base-url`	Upstream base URL
`--auth-method`	Upstream auth (`none`, `bearer`, …)
`--networks`	Accepted network; repeat for multiple
`--mode`	`testnet` or `mainnet`
`--file` / `--data`	Complete JSON payload (exclusive with field flags)

Do not submit masked credential values from a previous get response.

Delete

Deletes the service and all of its paywalls. Requires --yes.

proceeds services delete <id> --yes

Paywalls

List, update, and delete paywalls.

Transactions and events

Monitor payments and request events.

Authentication

Profiles and API keys.

Getting Started

Guides

Manage

API Reference

CLI

Agent Wallets

Create

List

Get

Update

Delete

Paywalls

Transactions and events

Authentication

​Create

​List

​Get

​Update

​Delete

​Related

Paywalls

Transactions and events

Authentication

Create

List

Get

Update

Delete

Related