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
Purchases

List purchases

GET
/purchases

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

Query Parameters

customerId?string

Restrict results to this customer.

status?string

Filter by purchase status (case-insensitive).

Value in

  • "SCHEDULED"
  • "ACTIVE"
  • "CANCELLED"
limit?integer

Maximum rows to return. Must be a positive number; clamped to 1–200.

Range1 <= value <= 200
Default50

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/purchases?customerId=cus_abc123&status=ACTIVE&limit=25"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "purchases": [      {        "id": "pur_ghi789",        "purchaseNumber": "PUR-2026-0042",        "customerId": "cus_abc123",        "customerName": "Acme Inc",        "planId": "plan_growth",        "planName": "Growth",        "planType": "WALLET",        "hasWallet": true,        "hasCredit": true,        "hasOutcome": false,        "hasUnit": false,        "billingCycle": "MONTHLY",        "cost": 499,        "currencyCode": "USD",        "billingDate": "2026-08-01T00:00:00.000Z",        "status": "SCHEDULED",        "autoPayment": true,        "autoPaymentPauseReason": "string",        "createdAt": "2026-07-01T09:45: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": 500,  "statusDetail": {    "status": "ERROR",    "message": "Could not complete the request."  },  "result": {}}

Remove a member DELETE

Previous Page

Create a purchase POST

Subscribes a customer to a plan. Any existing SCHEDULED/ACTIVE purchase for the customer is cancelled first. A cycle-0 invoice is issued immediately for non-PAYG plans.