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
Payments

Get a payment

Resolves only PAID invoices; anything else is a 404.

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

Payment id — the paid invoice's id.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/payments/inv_jkl012"
{  "statusCode": 200,  "statusDetail": {    "status": "SUCCESS",    "message": "OK"  },  "result": {    "payment": {      "id": "inv_jkl012",      "invoiceNumber": "INV-2026-0042",      "paymentNumber": "PAY-2026-0031",      "purchaseNumber": "PUR-2026-0042",      "customerId": "cus_abc123",      "customerName": "Acme Inc",      "customerSlug": "acme-inc",      "customerParty": {        "name": "Acme Inc",        "logoUrl": "string",        "legalName": "Acme Incorporated",        "email": "ops@acme.com",        "phone": "+1 415 555 0100",        "website": "https://acme.com",        "taxId": "US-EIN 12-3456789",        "addressLine1": "500 Market Street",        "city": "San Francisco",        "state": "CA",        "country": "United States",        "pincode": "94105"      },      "orgParty": {        "name": "Acme Inc",        "logoUrl": "string",        "legalName": "Acme Incorporated",        "email": "ops@acme.com",        "phone": "+1 415 555 0100",        "website": "https://acme.com",        "taxId": "US-EIN 12-3456789",        "addressLine1": "500 Market Street",        "city": "San Francisco",        "state": "CA",        "country": "United States",        "pincode": "94105"      },      "purchaseId": "pur_ghi789",      "stream": "ADVANCE",      "planId": "plan_growth",      "planName": "Growth",      "planType": "WALLET",      "plan": {        "name": "Growth",        "type": "WALLET",        "hasWallet": true,        "hasCredit": true,        "hasOutcome": false,        "hasUnit": false,        "kind": "FLAT_PRICE",        "billingCycle": "MONTHLY",        "cost": 499,        "currencyCode": "USD",        "spendingLimit": 1000,        "seatScope": "CUSTOMER",        "carryForward": true,        "billingDate": "2026-08-01T00:00:00.000Z",        "status": "ACTIVE"      },      "billingCycle": "MONTHLY",      "cycleIndex": 0,      "lineItems": [        {          "kind": "credit",          "label": "Deep Research credits",          "quantity": 5000        }      ],      "hasWallet": true,      "hasCredit": true,      "hasOutcome": false,      "hasUnit": false,      "amount": 499,      "currencyCode": "USD",      "currencyRateUsd": 1,      "status": "OPEN",      "issuedAt": "2026-07-01T09:45:05.000Z",      "paidAt": "2026-07-01T10:02:00.000Z",      "voidedAt": "string",      "paymentMode": "STRIPE",      "paymentReference": "pi_3Rt8kX2eZvKYlo2C",      "stripePaymentIntentId": "pi_3Rt8kX2eZvKYlo2C",      "autoPaid": true,      "notes": "Cycle 0 — issued at purchase",      "createdAt": "2026-07-01T09:45:05.000Z",      "createdByName": "Priya N.",      "paidByName": "Dana Whitman",      "voidedByName": "string"    },    "plan": {      "id": "plan_growth",      "name": "Growth"    }  }}
{  "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": {}}

List payments GET

A payment is a PAID invoice.

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`.