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

Get a purchase

GET
/purchases/{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

Purchase id.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/purchases/pur_ghi789"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "purchase": {      "id": "pur_ghi789",      "purchaseNumber": "PUR-2026-0042",      "status": "SCHEDULED",      "cost": 499,      "billingCycle": "MONTHLY",      "planName": "Growth",      "billingDate": "2026-08-01T00:00:00.000Z",      "nextBillingDate": "2026-09-01T00:00:00.000Z",      "createdAt": "2026-07-01T09:45:00.000Z",      "createdByName": "Priya N.",      "customer": {        "id": "cus_abc123",        "name": "Acme Inc"      },      "autoPayment": true,      "autoPaymentPauseReason": "string",      "autoPaymentPausedAt": "string",      "plan": {        "id": "plan_growth"      },      "stats": {        "invoiceCount": 3,        "paidCount": 2      }    }  }}
{  "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 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.

Update a purchase's auto-payment setting PATCH

Next Page