ClocknextHelp
DocumentationAPI ReferenceMCP Tools
Dashboard

Get started

OverviewQuickstart

Good to know

Response formatHandling errorsPaginating resultsSending data reliablyYour own customer idsWebhooks

API reference

Record credit POSTRecord outcome POSTComplete outcome POSTRecord wallet POSTRecord unit POSTComplete composite POST
List customers GETCreate a customer POSTGet a customer GETUpdate a customer PATCHDelete a customer DELETEGet a customer's balances GETGet a customer's wallet ledger GETSet a customer's low-balance alert PUTGet a customer's current plan GETChange a recurring grant PUTList Customer Usage Log GETLook Up Usage Logs by ID GET
Manage a customer's credit balance POSTManage a customer's outcome balance POSTManage a customer's unit balance POSTManage a customer's composite balance POSTManage a customer's wallet balance POST
List a customer's members GETAdd a member POSTUpdate a member PATCHRemove a member DELETE
PlansCreditsOutcomesUnitsComposites
List taxes GETCreate a tax POSTGet a tax GETUpdate a tax PATCH
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
wallet.balance.update POSTwallet.balance.drop POST
Mint a customer-portal access token POST
Entitlements and Plans

Outcomes

Multi-step deliverables billed per completed outcome. Nothing is deleted — archive instead.

List outcomes

GET
/outcomes

Lists your outcomes. Pass active=true for active ones only.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Query Parameters

active?boolean

true returns only active outcomes.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/outcomes?active=true"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "outcomes": [      {        "id": "oc_3n7p2",        "name": "Contract review",        "agentKey": "contract_review",        "description": "string",        "isActive": true,        "basePrice": 0.51,        "marginPercent": 100,        "pricePerOutcome": 1.02,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      }    ]  }}
{  "statusCode": 401,  "statusDetail": {    "status": "ERROR",    "message": "Invalid API key."  },  "result": {}}
{  "statusCode": 500,  "statusDetail": {    "status": "ERROR",    "message": "Could not complete the request."  },  "result": {}}

Create a outcome

POST
/outcomes

Creates an outcome. Each step is priced from its modelBundle.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

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

curl -X POST "https://example.com/outcomes" \  -H "Content-Type: application/json" \  -d '{    "name": "Contract review",    "agentKey": "contract_review",    "marginPercent": 100,    "steps": [      {        "name": "Extract clauses",        "agentKey": "contract_review.extract",        "modelBundle": [          {            "modelId": "claude-sonnet-4-5",            "averageTokensPerLLMCall": 50000,            "input": 70,            "output": 30,            "cache": 0,            "cacheWrite": 0          }        ]      },      {        "name": "Summarise",        "agentKey": "contract_review.summarise",        "modelBundle": [          {            "modelId": "claude-sonnet-4-5",            "averageTokensPerLLMCall": 20000,            "input": 50,            "output": 50,            "cache": 0,            "cacheWrite": 0          }        ]      }    ]  }'
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "created": true,    "outcome": {      "id": "oc_3n7p2",      "name": "Contract review",      "agentKey": "contract_review",      "description": "string",      "isActive": true,      "basePrice": 0.51,      "marginPercent": 100,      "pricePerOutcome": 1.02,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  }}
{  "statusCode": 400,  "statusDetail": {    "status": "ERROR",    "message": "Request body must be valid JSON."  },  "result": {}}
{  "statusCode": 401,  "statusDetail": {    "status": "ERROR",    "message": "Invalid API key."  },  "result": {}}
{  "statusCode": 409,  "statusDetail": {    "status": "ERROR",    "message": "Customer \"cus_abc123\" is archived."  },  "result": {}}
{  "statusCode": 500,  "statusDetail": {    "status": "ERROR",    "message": "Could not complete the request."  },  "result": {}}

Update a outcome

PATCH
/outcomes/{id}

Updates only the fields you send. Send each step's id to keep it.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Outcome id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Any create fields.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/outcomes/oc_3n7p2" \  -H "Content-Type: application/json" \  -d '{    "steps": [      {        "id": "st_a1",        "name": "Extract key clauses",        "agentKey": "contract_review.extract"      },      {        "id": "st_a2",        "name": "Summarise",        "agentKey": "contract_review.summarise"      }    ]  }'
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "updated": true,    "outcome": {      "id": "oc_3n7p2",      "name": "Contract review",      "agentKey": "contract_review",      "description": "string",      "isActive": true,      "basePrice": 0.51,      "marginPercent": 100,      "pricePerOutcome": 1.02,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  }}
{  "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": 409,  "statusDetail": {    "status": "ERROR",    "message": "Customer \"cus_abc123\" is archived."  },  "result": {}}
{  "statusCode": 500,  "statusDetail": {    "status": "ERROR",    "message": "Could not complete the request."  },  "result": {}}

Get a outcome

GET
/outcomes/{id}

Gets one outcome with its steps.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Outcome id.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/outcomes/oc_3n7p2"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "outcome": {      "id": "oc_3n7p2",      "name": "Contract review",      "agentKey": "contract_review",      "description": "string",      "isActive": true,      "basePrice": 0.51,      "marginPercent": 100,      "pricePerOutcome": 1.02,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "steps": [        {          "id": "st_a1",          "name": "Extract clauses",          "agentKey": "contract_review.extract",          "order": 0,          "basePrice": 0.33,          "modelBundle": [            {              "modelId": "claude-sonnet-4-5",              "modelName": "Claude Sonnet",              "averageTokensPerLLMCall": 100000,              "input": 60,              "output": 30,              "cache": 5,              "cacheWrite": 5            }          ]        }      ]    }  }}
{  "statusCode": 401,  "statusDetail": {    "status": "ERROR",    "message": "Invalid API key."  },  "result": {}}
{  "statusCode": 404,  "statusDetail": {    "status": "ERROR",    "message": "No customer with id \"cus_abc123\"."  },  "result": {}}
{  "statusCode": 500,  "statusDetail": {    "status": "ERROR",    "message": "Could not complete the request."  },  "result": {}}

Archive a outcome

POST
/outcomes/{id}/archive

Archives a outcome. Nothing is deleted.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Outcome id.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/outcomes/oc_3n7p2/archive"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "archived": true,    "outcome": {      "id": "oc_3n7p2",      "name": "Contract review",      "agentKey": "contract_review",      "description": "string",      "isActive": true,      "basePrice": 0.51,      "marginPercent": 100,      "pricePerOutcome": 1.02,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  }}
{  "statusCode": 401,  "statusDetail": {    "status": "ERROR",    "message": "Invalid API key."  },  "result": {}}
{  "statusCode": 404,  "statusDetail": {    "status": "ERROR",    "message": "No customer with id \"cus_abc123\"."  },  "result": {}}
{  "statusCode": 500,  "statusDetail": {    "status": "ERROR",    "message": "Could not complete the request."  },  "result": {}}

Unarchive a outcome

POST
/outcomes/{id}/unarchive

Restores an archived outcome.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Outcome id.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/outcomes/oc_3n7p2/unarchive"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "unarchived": true,    "outcome": {      "id": "oc_3n7p2",      "name": "Contract review",      "agentKey": "contract_review",      "description": "string",      "isActive": true,      "basePrice": 0.51,      "marginPercent": 100,      "pricePerOutcome": 1.02,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  }}
{  "statusCode": 401,  "statusDetail": {    "status": "ERROR",    "message": "Invalid API key."  },  "result": {}}
{  "statusCode": 404,  "statusDetail": {    "status": "ERROR",    "message": "No customer with id \"cus_abc123\"."  },  "result": {}}
{  "statusCode": 500,  "statusDetail": {    "status": "ERROR",    "message": "Could not complete the request."  },  "result": {}}

Credits

Credits your product draws down by `agentKey`, priced from a model bundle. Nothing is deleted — archive instead.

Units

Fixed-price events, priced FLAT, SLAB or VOLUME. Nothing is deleted — archive instead.

name*string
Length1 <= length <= 120
agentKey*string
Match^[a-z0-9._-]+$
Length1 <= length <= 80
description?|
Lengthlength <= 500
marginPercent*number
Range-100 <= value
steps*array<>
Items1 <= items <= 50
name?string
Length1 <= length <= 120
agentKey?string
Match^[a-z0-9._-]+$
Length1 <= length <= 80
description?|
Lengthlength <= 500
marginPercent?number
Range-100 <= value
steps?array<>
Items1 <= items <= 50