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

Get a customer's current plan

`plan` is null when there is no SCHEDULED or ACTIVE purchase.

GET
/customers/{id}/plan

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

Path Parameters

id*string

Customer id.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/customers/cus_abc123/plan"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "customerId": "cus_abc123",    "currency": {      "code": "USD",      "rateUsd": 1    },    "plan": {      "purchaseId": "pur_ghi789",      "planId": "plan_growth",      "planName": "Growth",      "planType": "BUNDLE",      "planKind": "FLAT_PRICE",      "seatScope": "CUSTOMER",      "billingCycle": "MONTHLY",      "cost": 499,      "status": "ACTIVE",      "billingDate": "2026-08-01T00:00:00.000Z",      "spendingLimit": 1000,      "spentThisCycle": 412.35,      "meters": {        "wallet": true,        "credit": true,        "outcome": false,        "unit": false      }    }  }}
{  "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": {}}

Get a customer's balances GET

Wallet, credit, outcome and unit balances under the customer's current plan. When `hasPlan` is false the balance collections are empty and `wallet` is null.

List a customer's wallet transactions GET

Returns the current USD wallet balance and recent wallet transactions.