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

GET
/customers/{id}

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"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "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": 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": {}}

Create a customer POST

Previous Page

Update a customer PATCH

Partial update. Any field sent as `null` clears that optional column; omitted fields are left untouched.