ClocknextHelp
DocumentationAPI ReferenceMCP Tools
Dashboard

Get started

OverviewQuickstart

Core concepts

The response envelopeErrorsPaginationAsync, flushing & reliability

API reference

Record Signals POSTRecord usage logs POST
List customers GETCreate a customer POSTGet a customer GETUpdate a customer PATCHDelete a customer DELETEGet a customer's balances GETGet a customer's current plan GETList a customer's wallet transactions GETAdd a wallet transaction POSTAdjust a customer's credit balance POSTAdjust a customer's outcome balance POSTAdjust a customer's unit balance POST
List a customer's members GETAdd a member POSTUpdate a member PATCHRemove a member DELETE
List purchases GETCreate a purchase POSTGet a purchase GETUpdate a purchase's auto-payment setting PATCHCancel a purchase POST
List invoices GETGet an invoice GETMint a hosted pay link GET
List payments GETGet a payment GET
Mint a customer-portal access token POST
Customers

Add a wallet transaction

POST
/customers/{id}/wallet

Authorization

apiKey
AuthorizationBearer <token>

Per-organisation API key from Settings → API Keys, sent as Authorization: Bearer cnk_…. Missing, unknown or expired keys return 401.

In: header

Path Parameters

id*string

Customer id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/customers/cus_abc123/wallet" \  -H "Content-Type: application/json" \  -d '{    "type": "CREDIT",    "amount": 250,    "notes": "Migration goodwill top-up"  }'
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "transaction": {      "id": "wtx_4c8d2e",      "type": "CREDIT",      "amount": 250,      "amountUsd": 250,      "currencyCode": "USD",      "currencyRateUsd": 1,      "notes": "Migration goodwill top-up",      "batchId": "string",      "createdAt": "2026-07-15T10:20:00.000Z",      "createdByName": "Priya N."    },    "balanceUsd": 262.5  }}
{  "statusCode": 400,  "statusDetail": {    "status": "ERROR",    "message": "Request body must be valid JSON."  },  "result": {}}
{  "statusCode": 401,  "statusDetail": {    "status": "ERROR",    "message": "Invalid API key."  },  "result": {}}
{  "statusCode": 404,  "statusDetail": {    "status": "ERROR",    "message": "No customer with id \"cus_abc123\"."  },  "result": {}}
{  "statusCode": 422,  "statusDetail": {    "status": "ERROR",    "message": "No credit with agent key \"summarize\" exists in this workspace."  },  "result": {}}
{  "statusCode": 500,  "statusDetail": {    "status": "ERROR",    "message": "Could not complete the request."  },  "result": {}}

List a customer's wallet transactions GET

Returns the current USD wallet balance and recent wallet transactions.

Adjust a customer's credit balance POST

Grant (positive `delta`) or claw back (negative `delta`) a credit balance.

type*WalletTransactionType

Value in

  • "CREDIT"
  • "DEBIT"
amount*number

Always positive; the sign comes from type.

Range0 < value <= 1000000000
notes?string
Lengthlength <= 200