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
Webhooks

wallet.balance.drop

Triggered when a customer's Wallet balance falls to or below their low-balance alert level, or the endpoint's threshold if they have none.

Header Parameters

X-Clocknext-Signature*string

t=<unix seconds>,v1=<hex HMAC-SHA256> — the HMAC of ${t}.${rawBody} keyed with the endpoint's signing secret. See Verify the signature.

X-Clocknext-Event-Id*string

The event's id — the same as id in the body, and the same on every retry.

X-Clocknext-Event-Type*string

The event name — the same as event_type in the body.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

{  "id": "evt_3f9a1c6e8b2d4f7a9c0e1b2d3f4a5b6c",  "event_type": "wallet.balance.drop",  "triggered_at": "2026-10-07T14:02:51.093Z",  "data": {    "customer": {      "id": "cus_abc123",      "name": "Acme Corp"    },    "threshold": 50,    "previous_balance": 50.42,    "current_balance": 49.87,    "currency_code": "usd"  }}
Content-Type: application/jsonX-Clocknext-Signature: t=1791367200,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bdX-Clocknext-Event-Id: evt_3f9a1c6e8b2d4f7a9c0e1b2d3f4a5b6cX-Clocknext-Event-Type: wallet.balance.drop

wallet.balance.update POST

Triggered when a customer's Wallet balance increases or decreases. High volume: every usage charge on the Wallet triggers it too.

Mint a customer-portal access token POST

Returns a short-lived HS256 JWT for the customer portal. A customer not in the key's organisation is reported as `400` here (not `404`); an `organizationId` mismatch is `403`.

id*string

evt_ + 32 hex characters. Unique per event, and the same on every retry of it — use it to skip duplicates.

event_type*string
triggered_at*string

When the event was triggered (ISO 8601).

Formatdate-time
data*