Skip to main content
WEBHOOK
subscription
{
  "id": "<string>",
  "type": "subscription.activated",
  "object": "event",
  "created": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.clinkbill.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Your secret API key obtained from the Clink dashboard (Developers section)

​
X-Timestamp
string
header
required

Current timestamp in milliseconds since Unix epoch (required for request signing)

Body

application/json

Subscription event payload in json

​
id
string

Unique identifier for the event

​
type
enum<string>

Type of event that occurred

Available options:
subscription.created,
subscription.trialing,
subscription.activated,
subscription.incomplete_expired,
subscription.past_due,
subscription.cancelled,
subscription.updated.plan_changed,
subscription.updated.plan_change_canceled,
subscription.updated.renewed,
subscription.updated.cancel_at_period_end_set,
subscription.updated.cancel_at_period_end_revoked
Example:

"subscription.activated"

​
object
string

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

Example:

"event"

​
created
string<date-time>

Timestamp when the event occurred

​
data
object

Subscription data object containing all subscription details

Response

200

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