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

Create a customer

POST
/customers

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

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/customers" \  -H "Content-Type: application/json" \  -d '{    "name": "Acme Inc",    "email": "ops@acme.com",    "description": "AI meeting-notes startup — growth tier",    "website": "https://acme.com",    "phone": "+1 415 555 0100",    "legalName": "Acme Incorporated",    "addressLine1": "500 Market Street",    "addressLine2": "Suite 400",    "city": "San Francisco",    "state": "CA",    "country": "United States",    "pincode": "94105",    "taxId": "US-EIN 12-3456789",    "notes": "Design partner — invoices reviewed by finance before send",    "currencyCode": "USD"  }'
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "customerId": "cus_abc123",    "customer": {      "id": "cus_abc123",      "slug": "acme-inc",      "name": "Acme Inc",      "description": "AI meeting-notes startup — growth tier",      "email": "ops@acme.com",      "website": "https://acme.com",      "phone": "+1 415 555 0100",      "legalName": "Acme Incorporated",      "addressLine1": "500 Market Street",      "addressLine2": "Suite 400",      "city": "San Francisco",      "state": "CA",      "country": "United States",      "pincode": "94105",      "taxId": "US-EIN 12-3456789",      "notes": "Design partner — invoices reviewed by finance before send",      "logoUrl": "string",      "currencyCode": "USD",      "creditAllowance": 10000,      "createdAt": "2026-07-01T09:30:00.000Z",      "updatedAt": "2026-07-18T11:12:00.000Z"    }  }}
{  "statusCode": 400,  "statusDetail": {    "status": "ERROR",    "message": "Request body must be valid JSON."  },  "result": {}}
{  "statusCode": 401,  "statusDetail": {    "status": "ERROR",    "message": "Invalid API key."  },  "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 customers GET

Cursor-paginated list of the organisation's customers.

Get a customer GET

Next Page

name*string
Length1 <= length <= 120
description?|
Lengthlength <= 500
email*|
Formatemail
Lengthlength <= 200
website?|
Lengthlength <= 200
phone?|
Lengthlength <= 40
legalName?|
Lengthlength <= 200
addressLine1?|
Lengthlength <= 200
addressLine2?|
Lengthlength <= 200
city?|
Lengthlength <= 100
state?|
Lengthlength <= 100
country?|
Lengthlength <= 100
pincode?|
Lengthlength <= 20
taxId?|
Lengthlength <= 60
notes?|
Lengthlength <= 2000
logoUrl?|

Data URL; capped at a maximum byte size.

currencyCode?string

ISO 4217 code; must be enabled for the organisation. Defaults to the organisation's primary currency (USD if none is set) when omitted on create.

Length3 <= length <= 3