invoice - Clink Documentation

{ "id": "<string>", "type": "invoice.void", "object": "event", "created": 123, "data": { "object": { "invoiceId": "<string>", "subscriptionId": "<string>", "orderId": "<string>", "customerId": "<string>", "merchantId": "<string>", "createTime": 1754819712625, "currentPeriodStart": 1754819706689, "currentPeriodEnd": 1755078906689, "originalAmount": 9.99, "originalCurrency": "USD", "items": [ { "invoiceItemId": "<string>", "amount": 9.99, "description": "<string>", "periodStart": 1754819706689, "periodEnd": 1755078906689, "proration": true, "price": { "productId": "<string>", "productName": "<string>", "priceId": "<string>", "priceSnapshotId": "<string>", "unitAmount": 9.99, "quantity": 1 } } ] } } }

Headers

X-Clink-Timestamp

string

required

Timestamp sent by Clink for webhook signature verification.

X-Clink-Signature

string

required

Hex-encoded HMAC-SHA256 signature generated with the webhook signing secret over the string ${X-Clink-Timestamp}.${rawRequestBody}. Use the raw request body bytes/string exactly as received; do not parse and re-serialize the JSON before verifying.

X-Clink-SignType

enum<string>

required

Signature algorithm used to generate X-Clink-Signature. The current value is SHA256.

Available options:

SHA256

Body

application/json

Invoice event payload in json

string

Unique identifier for the event

type

enum<string>

Type of event that occurred

Available options:

invoice.open,

invoice.paid,

invoice.void

Example:

"invoice.void"

object

string

Type of this json payload, 'event' if this is an event

Example:

"event"

created

integer<int64>

Unix timestamp in milliseconds when the event occurred

data

object

Show child attributes

Response

200

Return a 200 status to indicate that the data was received successfully