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

Credits

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

List credits

GET
/credits

Lists your credits. 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 credits.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/credits?active=true"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "credits": [      {        "id": "cr_8f2k1",        "name": "Deep Research",        "agentKey": "deep_research",        "description": "string",        "tokensPerCredit": 100000,        "basePrice": 0.65025,        "modelBundle": [          {            "modelId": "claude-sonnet-4-5",            "modelName": "Claude Sonnet",            "averageTokensPerLLMCall": 100000,            "input": 60,            "output": 30,            "cache": 5,            "cacheWrite": 5          }        ],        "marginPercent": 20,        "pricePerCredit": 0.7803,        "isActive": true,        "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 credit

POST
/credits

Creates a credit. Its price is worked out from 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/credits" \  -H "Content-Type: application/json" \  -d '{    "name": "Deep Research",    "agentKey": "deep_research",    "description": "One research query",    "marginPercent": 20,    "modelBundle": [      {        "modelId": "claude-sonnet-4-5",        "averageTokensPerLLMCall": 100000,        "input": 60,        "output": 30,        "cache": 5,        "cacheWrite": 5      }    ]  }'
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "created": true,    "credit": {      "id": "cr_8f2k1",      "name": "Deep Research",      "agentKey": "deep_research",      "description": "string",      "tokensPerCredit": 100000,      "basePrice": 0.65025,      "modelBundle": [        {          "modelId": "claude-sonnet-4-5",          "modelName": "Claude Sonnet",          "averageTokensPerLLMCall": 100000,          "input": 60,          "output": 30,          "cache": 5,          "cacheWrite": 5        }      ],      "marginPercent": 20,      "pricePerCredit": 0.7803,      "isActive": true,      "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 credit

PATCH
/credits/{id}

Updates only the fields you send. Send modelBundle to re-price.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Credit 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/credits/cr_8f2k1" \  -H "Content-Type: application/json" \  -d '{    "marginPercent": 50  }'
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "updated": true,    "credit": {      "id": "cr_8f2k1",      "name": "Deep Research",      "agentKey": "deep_research",      "description": "string",      "tokensPerCredit": 100000,      "basePrice": 0.65025,      "modelBundle": [        {          "modelId": "claude-sonnet-4-5",          "modelName": "Claude Sonnet",          "averageTokensPerLLMCall": 100000,          "input": 60,          "output": 30,          "cache": 5,          "cacheWrite": 5        }      ],      "marginPercent": 20,      "pricePerCredit": 0.7803,      "isActive": true,      "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 credit

GET
/credits/{id}

Gets one credit.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Credit id.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/credits/cr_8f2k1"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "credit": {      "id": "cr_8f2k1",      "name": "Deep Research",      "agentKey": "deep_research",      "description": "string",      "tokensPerCredit": 100000,      "basePrice": 0.65025,      "modelBundle": [        {          "modelId": "claude-sonnet-4-5",          "modelName": "Claude Sonnet",          "averageTokensPerLLMCall": 100000,          "input": 60,          "output": 30,          "cache": 5,          "cacheWrite": 5        }      ],      "marginPercent": 20,      "pricePerCredit": 0.7803,      "isActive": true,      "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": {}}

Archive a credit

POST
/credits/{id}/archive

Archives a credit. Nothing is deleted.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Credit id.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/credits/cr_8f2k1/archive"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "archived": true,    "credit": {      "id": "cr_8f2k1",      "name": "Deep Research",      "agentKey": "deep_research",      "description": "string",      "tokensPerCredit": 100000,      "basePrice": 0.65025,      "modelBundle": [        {          "modelId": "claude-sonnet-4-5",          "modelName": "Claude Sonnet",          "averageTokensPerLLMCall": 100000,          "input": 60,          "output": 30,          "cache": 5,          "cacheWrite": 5        }      ],      "marginPercent": 20,      "pricePerCredit": 0.7803,      "isActive": true,      "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 credit

POST
/credits/{id}/unarchive

Restores an archived credit.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Credit id.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/credits/cr_8f2k1/unarchive"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "unarchived": true,    "credit": {      "id": "cr_8f2k1",      "name": "Deep Research",      "agentKey": "deep_research",      "description": "string",      "tokensPerCredit": 100000,      "basePrice": 0.65025,      "modelBundle": [        {          "modelId": "claude-sonnet-4-5",          "modelName": "Claude Sonnet",          "averageTokensPerLLMCall": 100000,          "input": 60,          "output": 30,          "cache": 5,          "cacheWrite": 5        }      ],      "marginPercent": 20,      "pricePerCredit": 0.7803,      "isActive": true,      "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": {}}

Plans

Plans customers subscribe to. Nothing is deleted — archive instead.

Outcomes

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

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