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 Portal

Mint a customer-portal access token POST

Retry signals

Deprecated. Use Retry signals on events.clocknext.com; @clocknext/sdk 0.20 and later already do. Sends 1 to 50 PENDING signals again. A signal gets 11 attempts, then becomes REJECTED.

Deprecated

Base URL https://payments.clocknext.com/api/v1

POST
/signal/retry

Authorization

apiKey
headerAuthorizationBearer <cnk_…>

Organisation-scoped key from Settings → API Keys.

Request Body

application/json
  1. body
  1. body
  2. …
signalIds*array<>

1 to 50 signal ids to send again.

Items1 <= items <= 50

Response Body

The ids, sorted by result. A 202 also when no id was queued.

application/json
  1. response
  1. response
  2. …
statusCode*integer

The HTTP status code of the response, repeated in the body.

statusDetail*

The status of the request. status is SUCCESS, and message says what happened.

result*

The ids you sent, sorted into one list for each result.

curl -X POST 'https://payments.clocknext.com/api/v1/signal/retry' \  -H 'Content-Type: application/json' \  -d '{  "signalIds": [    "01a15a15-ccec-758e-ad47-1f18e965ad90",    "01a15a15-cbda-71e8-8e8f-8a4cc080bdd6",    "01a15a15-caca-712e-ae8c-7ac5e1c3fe68",    "01a15a15-c9b8-72a0-a2c9-466de0f8fc56",    "01a15a15-9753-7652-a00b-2ef6597b1f12"  ]}'
Example Response
{  "statusCode": 202,  "statusDetail": {    "status": "SUCCESS",    "message": "Signals queued for retry."  },  "result": {    "queued": [      {        "signalId": "01a15a15-ccec-758e-ad47-1f18e965ad90",        "attempt": 2      },      {        "signalId": "01a15a15-cbda-71e8-8e8f-8a4cc080bdd6",        "attempt": 2      },      {        "signalId": "01a15a15-caca-712e-ae8c-7ac5e1c3fe68",        "attempt": 2      }    ],    "notFound": [],    "attemptLimitReached": [],    "notPending": [],    "failed": []  }}

Types

Every object type on this page, with its fields.

SignalRetryResult

FieldTypeRequiredDescription
queuedobject[]yesSent for processing again, with this attempt number. Read the result later.
notFoundstring[]yesNo signal with this id in your organization.
attemptLimitReachedstring[]yesThe signal has used all 11 attempts. Send a new signal instead.
notPendingstring[]yesCounted already, REJECTED, or stored without a body to send.
failedstring[]yesNot sent this time (a short outage, or its externalId could not be looked up). Retry these ids.

SignalRetryResult.queued

FieldTypeRequiredDescription
signalIdstringyesThe signal id, in lower case.
attemptintegeryesThe number of this attempt. The first send is attempt 1.

List raw signals GET

Deprecated. Use [List raw signals](/docs/api-reference/signals/eventsListSignals) on `events.clocknext.com`; `@clocknext/sdk` 0.20 and later already do. Your organization's signals with their status, newest first, 50 a page, for the last 30 days.

List customers GET

Cursor-paginated list of the organisation's customers. A `cursor` that is not a customer of this workspace is a 400 "Invalid `cursor`.", never an empty last page.