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
Payments

List payments

A payment is a PAID invoice.

GET
/payments

Authorization

apiKey
AuthorizationBearer <token>

Organisation-scoped key from Settings → API Keys.

In: header

Query Parameters

customerId?string

Restrict results to this customer.

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/payments?customerId=cus_abc123&limit=25"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "payments": [      {        "id": "inv_jkl012",        "paymentNumber": "PAY-2026-0031",        "invoiceNumber": "INV-2026-0042",        "purchaseNumber": "PUR-2026-0042",        "customerId": "cus_abc123",        "customerName": "Acme Inc",        "planName": "Growth",        "amount": 499,        "currencyCode": "USD",        "paymentMode": "STRIPE",        "paymentReference": "pi_3Rt8kX2eZvKYlo2C",        "paidAt": "2026-07-01T10:02:00.000Z",        "paidByName": "Dana Whitman"      }    ]  }}
{  "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": {}}

Mint a hosted pay link GET

Returns a hosted checkout URL. Fails with 409 when the invoice is not OPEN.

Get a payment GET

Resolves only PAID invoices; anything else is a 404.