billing:topup

billing family

Top up workspace AI credits — returns the checkout URL of a credits PACK. Credits are sold only as packs priced by the pack table (one.ie/web lib/credits-packs.ts, USD, at CREDITS_PER_USD): name `credits` or the pack's USD `amount`; a number that names no pack, or credits and amount that disagree, is refused (not_a_pack / amount_mismatch) with `packs` and a `suggested` pack. Credits are prepaid, NON-WITHDRAWABLE service units: they buy work on ONE (AI replies, tool and skill calls, agent runs, storage, API requests) and there is no payout, withdraw or cash-out rail against a credits balance

Effect: ask; Awaits an outcome — the call returns the response below.
Caller: update_group; The class of authority the caller must already hold, decided from the attested context with no round trip.
Cost: free; What one call costs, so you can budget before acting.
Reversible: no; This cannot be undone. Dry-run it first where the contract allows.
Idempotent: no; Not safe to blind-retry — dedupe on the envelope idempotencyKey.

Send it with your agent

One click hands your coding agent a prompt that registers the substrate, reads this contract, and makes the call. Launch opens the app; the others copy the prompt.

Claude Code

Codex

Cursor

Gemini CLI

Claude Desktop

ChatGPT

curl -X POST https://one.ie/api/ask/billing:topup \
  -H "Authorization: Bearer $ONE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data": { "slug": <string>, "actorId": <string> }}'

The key is never in a link. npx -y @oneie/cli login writes it to ~/.config/oneie/key on your machine.

Request

Validated before dispatch — an invalid payload is refused with the fix, never half-applied.

slug string required
actorId string required
credits number optional
amount number optional
currency string optional

Response

What comes back from the call.

ok boolean
intent string
checkoutUrl string
ppid string
credits number
amount number
currency string
suggested object
packs object[]
reason string

Traffic

Every call to billing:topup, counted where it is dispatched — over HTTP or in-process alike. Aggregate only — no actor, no payload, no workspace.

Counting…

Wiring

Every place in the open source that names billing:topup, and the file that answers it. Read from the tree at build time — a receiver is reached by NAME through one door, so there is no import edge to follow and a grep is the honest shape of the question. Structure, not volume — the count is in Traffic above.

Called from

API route 2

one.ie/web/src/lib/receiver-index.generated.ts:53
one.ie/web/src/lib/resolvers/market.ts:1971

Agent runtime 1

channels/src/tools/billing.ts:6

Workflow 1

one.ie/web/src/lib/workflow-templates.ts:2316

→

Answered by

billing:topup one.ie/web/src/lib/resolvers/market.ts:1970 Dispatched through POST /api/ask/billing:topup, after the envelope validates the payload.

billing family · 4 more

billing:clients billing:list billing:plan billing:set-markup

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "slug": {
      "type": "string"
    },
    "actorId": {
      "type": "string"
    },
    "credits": {
      "type": "number"
    },
    "amount": {
      "type": "number"
    },
    "currency": {
      "type": "string"
    }
  },
  "required": [
    "slug",
    "actorId"
  ]
}

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "intent": {
      "type": "string"
    },
    "checkoutUrl": {
      "type": "string"
    },
    "ppid": {
      "type": "string"
    },
    "credits": {
      "type": "number"
    },
    "amount": {
      "type": "number"
    },
    "currency": {
      "type": "string"
    },
    "suggested": {
      "type": "object",
      "properties": {
        "credits": {
          "type": "number"
        },
        "usd": {
          "type": "number"
        },
        "ppid": {
          "type": "string"
        }
      },
      "required": [
        "credits",
        "usd",
        "ppid"
      ]
    },
    "packs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "credits": {
            "type": "number"
          },
          "usd": {
            "type": "number"
          },
          "ppid": {
            "type": "string"
          }
        },
        "required": [
          "credits",
          "usd",
          "ppid"
        ]
      }
    },
    "reason": {
      "type": "string"
    }
  },
  "required": [
    "ok"
  ]
}