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

Composites

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

List composites

GET
/composites

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

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/composites?active=true"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "composites": [      {        "id": "cmp_7d1x9",        "name": "Voice AI call",        "refId": "voice_ai",        "description": "string",        "price": 2.5,        "isActive": true,        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z",        "entitlements": {          "credits": [            {              "id": "string",              "name": "string",              "agentKey": "string"            }          ],          "outcomes": [            {              "id": "string",              "name": "string",              "agentKey": "string"            }          ],          "units": [            {              "id": "string",              "name": "string",              "agentKey": "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 composite

POST
/composites

Creates a composite. It bills only once a plan sells it.

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/composites" \  -H "Content-Type: application/json" \  -d '{    "name": "Voice AI call",    "refId": "voice_ai",    "price": 2.5,    "entitlements": {      "creditIds": [        "cr_8f2k1"      ],      "unitIds": [        "un_flat01"      ]    }  }'
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "created": true,    "composite": {      "id": "cmp_7d1x9",      "name": "Voice AI call",      "refId": "voice_ai",      "description": "string",      "price": 2.5,      "isActive": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "entitlements": {        "credits": [          {            "id": "string",            "name": "string",            "agentKey": "string"          }        ],        "outcomes": [          {            "id": "string",            "name": "string",            "agentKey": "string"          }        ],        "units": [          {            "id": "string",            "name": "string",            "agentKey": "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 composite

PATCH
/composites/{id}

Updates only the fields you send.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Composite 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/composites/cmp_7d1x9" \  -H "Content-Type: application/json" \  -d '{    "price": 3  }'
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "updated": true,    "composite": {      "id": "cmp_7d1x9",      "name": "Voice AI call",      "refId": "voice_ai",      "description": "string",      "price": 2.5,      "isActive": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "entitlements": {        "credits": [          {            "id": "string",            "name": "string",            "agentKey": "string"          }        ],        "outcomes": [          {            "id": "string",            "name": "string",            "agentKey": "string"          }        ],        "units": [          {            "id": "string",            "name": "string",            "agentKey": "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 composite

GET
/composites/{id}

Gets one composite.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Composite id.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/composites/cmp_7d1x9"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "composite": {      "id": "cmp_7d1x9",      "name": "Voice AI call",      "refId": "voice_ai",      "description": "string",      "price": 2.5,      "isActive": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "entitlements": {        "credits": [          {            "id": "string",            "name": "string",            "agentKey": "string"          }        ],        "outcomes": [          {            "id": "string",            "name": "string",            "agentKey": "string"          }        ],        "units": [          {            "id": "string",            "name": "string",            "agentKey": "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 composite

POST
/composites/{id}/archive

Archives a composite. Nothing is deleted.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Composite id.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/composites/cmp_7d1x9/archive"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "archived": true,    "composite": {      "id": "cmp_7d1x9",      "name": "Voice AI call",      "refId": "voice_ai",      "description": "string",      "price": 2.5,      "isActive": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "entitlements": {        "credits": [          {            "id": "string",            "name": "string",            "agentKey": "string"          }        ],        "outcomes": [          {            "id": "string",            "name": "string",            "agentKey": "string"          }        ],        "units": [          {            "id": "string",            "name": "string",            "agentKey": "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 composite

POST
/composites/{id}/unarchive

Restores an archived composite.

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Path Parameters

id*string

Composite id.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/composites/cmp_7d1x9/unarchive"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "unarchived": true,    "composite": {      "id": "cmp_7d1x9",      "name": "Voice AI call",      "refId": "voice_ai",      "description": "string",      "price": 2.5,      "isActive": true,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "entitlements": {        "credits": [          {            "id": "string",            "name": "string",            "agentKey": "string"          }        ],        "outcomes": [          {            "id": "string",            "name": "string",            "agentKey": "string"          }        ],        "units": [          {            "id": "string",            "name": "string",            "agentKey": "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": {}}

Units

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

List taxes GET

Lists your taxes, oldest first. Archived taxes are included; pass `active=true` for only the ones that apply to new invoices.

name*string
Length1 <= length <= 80
refId*string
Match^[a-z0-9._-]+$
Length1 <= length <= 80
description?|
Lengthlength <= 400
price*number
Range0 <= value <= 10000000
entitlements*

At least one id.

name?string
Length1 <= length <= 80
refId?string
Match^[a-z0-9._-]+$
Length1 <= length <= 80
description?|
Lengthlength <= 400
price?number
Range0 <= value <= 10000000
entitlements?

At least one id.