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

Units

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

List units

GET
/units

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

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/units?active=true"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "units": [      {        "id": "un_5q9w4",        "name": "API calls",        "agentKey": "api_calls",        "description": "string",        "pricingType": "SLAB",        "flatPrice": 0,        "tiers": [          {            "id": "tr_1",            "upTo": 1000,            "price": 0.01,            "order": 0          }        ],        "isActive": true,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "createdByName": "string"      }    ]  }}
{  "statusCode": 401,  "statusDetail": {    "status": "ERROR",    "message": "Invalid API key."  },  "result": {}}
{  "statusCode": 500,  "statusDetail": {    "status": "ERROR",    "message": "Could not complete the request."  },  "result": {}}

Create a unit

POST
/units

Creates a unit. The last tier must have upTo: null.

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/units" \  -H "Content-Type: application/json" \  -d '{    "name": "API calls",    "agentKey": "api_calls",    "pricingType": "SLAB",    "tiers": [      {        "upTo": 1000,        "price": 0.01      },      {        "upTo": null,        "price": 0.005      }    ]  }'
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "created": true,    "unit": {      "id": "un_5q9w4",      "name": "API calls",      "agentKey": "api_calls",      "description": "string",      "pricingType": "SLAB",      "flatPrice": 0,      "tiers": [        {          "id": "tr_1",          "upTo": 1000,          "price": 0.01,          "order": 0        }      ],      "isActive": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "createdByName": "string"    }  }}
{  "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 unit

PATCH
/units/{id}

Updates only the fields you send.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Unit 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/units/un_5q9w4" \  -H "Content-Type: application/json" \  -d '{    "description": "Billed per request"  }'
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "updated": true,    "unit": {      "id": "un_5q9w4",      "name": "API calls",      "agentKey": "api_calls",      "description": "string",      "pricingType": "SLAB",      "flatPrice": 0,      "tiers": [        {          "id": "tr_1",          "upTo": 1000,          "price": 0.01,          "order": 0        }      ],      "isActive": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "createdByName": "string"    }  }}
{  "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 unit

GET
/units/{id}

Gets one unit.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Unit id.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/units/un_5q9w4"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "unit": {      "id": "un_5q9w4",      "name": "API calls",      "agentKey": "api_calls",      "description": "string",      "pricingType": "SLAB",      "flatPrice": 0,      "tiers": [        {          "id": "tr_1",          "upTo": 1000,          "price": 0.01,          "order": 0        }      ],      "isActive": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "createdByName": "string"    }  }}
{  "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 unit

POST
/units/{id}/archive

Archives a unit. Nothing is deleted.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Unit id.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/units/un_5q9w4/archive"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "archived": true,    "unit": {      "id": "un_5q9w4",      "name": "API calls",      "agentKey": "api_calls",      "description": "string",      "pricingType": "SLAB",      "flatPrice": 0,      "tiers": [        {          "id": "tr_1",          "upTo": 1000,          "price": 0.01,          "order": 0        }      ],      "isActive": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "createdByName": "string"    }  }}
{  "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 unit

POST
/units/{id}/unarchive

Restores an archived unit.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Unit id.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/units/un_5q9w4/unarchive"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "unarchived": true,    "unit": {      "id": "un_5q9w4",      "name": "API calls",      "agentKey": "api_calls",      "description": "string",      "pricingType": "SLAB",      "flatPrice": 0,      "tiers": [        {          "id": "tr_1",          "upTo": 1000,          "price": 0.01,          "order": 0        }      ],      "isActive": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "createdByName": "string"    }  }}
{  "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": {}}

Outcomes

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

Composites

Credits, outcomes and units billed together as one thing. Nothing is deleted — archive instead.

name*string
Length1 <= length <= 80
agentKey*string
Match^[a-z0-9._-]+$
Length1 <= length <= 80
description?|
Lengthlength <= 400
pricingType*string

Value in

  • "FLAT"
  • "SLAB"
  • "VOLUME"
flatPrice?number

FLAT only.

Range0 <= value
tiers?array<>

SLAB / VOLUME only. Last tier has upTo: null.

Itemsitems <= 50
name?string
Length1 <= length <= 80
agentKey?string
Match^[a-z0-9._-]+$
Length1 <= length <= 80
description?|
Lengthlength <= 400
pricingType?string

Value in

  • "FLAT"
  • "SLAB"
  • "VOLUME"
flatPrice?number
Range0 <= value
tiers?array<>
Itemsitems <= 50