ClocknextHelp
DocumentationAPI ReferenceMCP Tools
Dashboard

Get started

OverviewQuickstart

Good to know

Response formatHandling errorsPaginating resultsSending data reliablyYour own customer idsWebhooks

API reference

Record credit POSTRecord outcome POSTComplete outcome POSTRecord wallet POSTRecord unit POSTComplete composite POST
List customers GETCreate a customer POSTGet a customer GETUpdate a customer PATCHDelete a customer DELETEGet a customer's balances GETGet a customer's wallet ledger GETSet a customer's low-balance alert PUTGet a customer's current plan GETChange a recurring grant PUTList Customer Usage Log GETLook Up Usage Logs by ID GET
Manage a customer's credit balance POSTManage a customer's outcome balance POSTManage a customer's unit balance POSTManage a customer's composite balance POSTManage a customer's wallet balance POST
List a customer's members GETAdd a member POSTUpdate a member PATCHRemove a member DELETE
PlansCreditsOutcomesUnitsComposites
List taxes GETCreate a tax POSTGet a tax GETUpdate a tax PATCH
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
wallet.balance.update POSTwallet.balance.drop POST
Mint a customer-portal access token POST
Purchases

Get a purchase

GET
/purchases/{id}

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

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. The plan itself must be active — purchasing an inactive plan is rejected with `400`. Every invoice includes the taxes set up for the customer's billing country (Settings → Taxes); see `subtotal`, `taxAmount` and `taxes` on the invoice.

Update a purchase's auto-payment setting PATCH

Next Page