ClocknextClocknextHelp
DocumentationAPI ReferenceMCP Tools
Dashboard

Get started

OverviewQuickstart

Good to know

Response formatHandling errorsPaginating resultsSending data reliablyYour own customer idsWebhooks

API reference

Signals

Record credit POSTRecord outcome POSTComplete outcome POSTRecord wallet POSTRecord unit POSTComplete composite POSTList raw signals GETRetry signals POSTList Customer Usage Log GETLook Up Usage Logs by ID GET

Deprecated

Record credit POSTRecord outcome POSTComplete outcome POSTRecord wallet POSTRecord unit POSTComplete composite POSTList raw signals GETRetry signals POST

Customers

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 for wallet PUTGet a customer's current plan GETChange a recurring grant PUTUpdate a customer's card POSTGet a customer's invoice balance GETAdjust a customer's invoice balance POST

Deprecated

List Customer Usage Log GETLook Up Usage Logs by ID GET

Manage

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

Members

List a customer's members GETAdd a member POSTUpdate a member PATCHRemove a member DELETE

Plans and Entitlements

PlansPackagesCreditsOutcomesUnitsComposites

Taxes

List taxes GETCreate a tax POSTGet a tax GETUpdate a tax PATCH

Purchases

List purchases GETCreate a purchase POSTGet a purchase GETUpdate a purchase's auto-payment setting PATCHCancel a purchase POST

Checkout

Create a checkout POST

Subscriptions

List subscriptions GETGet a subscription GETCancel a subscription POSTAdd packages to a subscription POSTRemove a package from a subscription POST

Plan changes

List plan changes GETPreview a plan change POSTChange a customer's plan POSTGet a plan change GET

Invoices

List invoices GETGet an invoice GETMint a hosted pay link GETRecord a payment POST

Credit notes

List credit notes GETCreate a credit note POSTGet a credit note GETVoid a credit note POST

Refunds

List refunds GETRefund to the card POSTGet a refund GET

Payments

List payments GETGet a payment GET

Webhooks

customer.created POSTcustomer.updated POSTcustomer.archived POSTcustomer.restored POST

Customer Portal

Mint a customer-portal access token POST
Customer

customer.created

Triggered when a customer is added, in the Clocknext UI or through the Public API v1.

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
  1. body
  1. body
  2. …
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

Always customer.created.

triggered_at*string

When the event was triggered (ISO 8601).

Formatdate-time
data*

The customer, as it is after the change.

Response Body

Answer any 2xx within 5 seconds; the body is ignored. Anything else counts as failed and is retried.

Example Requests
POST/customer.created
Request Body
application/json
{  "id": "evt_d2dee58c041f800bbf94034653c9868e",  "event_type": "customer.created",  "triggered_at": "2026-10-01T08:00:00.214Z",  "data": {    "customer": {      "id": "cus_abc123",      "name": "Acme Corp",      "external_id": "acme-42",      "email": "billing@acme.com",      "currency_code": "inr",      "status": "ACTIVE",      "created_at": "2026-10-01T08:00:00.000Z"    }  }}
Header Parameters
{  "X-Clocknext-Signature": "t=1791367200,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd",  "X-Clocknext-Event-Id": "evt_d2dee58c041f800bbf94034653c9868e",  "X-Clocknext-Event-Type": "customer.created"}

Types

Every object type on this page, with its fields.

CustomerCreatedEvent

FieldTypeRequiredDescription
idstringyesevt_ + 32 hex characters. Unique per event, and the same on every retry of it — use it to skip duplicates.
event_typestringyesAlways customer.created.
triggered_atstringyesWhen the event was triggered (ISO 8601).
dataCustomerEventDatayesThe customer, as it is after the change.

CustomerEventData

The data object of a customer.created, customer.archived or customer.restored event: the customer, as it is after the change.

FieldTypeRequiredDescription
customerWebhookCustomerDetailsyesThe customer the event is about, as it is after the change.

WebhookCustomerDetails

The customer the event is about, as it is after the change.

FieldTypeRequiredDescription
idstringyesThe customer's Clocknext id.
namestringyesThe customer's name.
external_idstring | nullyesYour own id for the customer. Null when none is set.
emailstring | nullyesThe customer's email. Null when none is set.
currency_codestringyesThe customer's currency, lowercase (ISO 4217) — what they pay in at checkout.
status"ACTIVE" | "ARCHIVED"yesARCHIVED once the customer is archived, else ACTIVE.
created_atstringyesWhen the customer was added (ISO 8601).

wallet.balance.drop POST

Triggered when a customer's Wallet balance falls to or below their low-balance threshold, or the endpoint's threshold if they have none. The level is in USD (`threshold`) or a percentage of the plan's Wallet amount per cycle (`threshold_percentage`).

customer.updated POST

Triggered when a customer's details change, such as the name, email, external id, address or currency.