Skip to main content
GET
Who am I, and what can I do

Authorizations

Authorization
string
header
required

An API key (klk_...) or a Clerk session token. Both resolve to the same account and behave identically.

Response

The account.

email
string
required
status
enum<string>
required

past_due is treated as active — a failed card is not abuse. cancelled cannot create or edit, but every link it ever made keeps resolving.

Available options:
free,
active,
past_due,
cancelled
plan
enum<string> | null
required

The paid plan, or null when the account is not subscribed. starter allows 100 new links per billing cycle; unlimited follows the trust ramp. Both include every feature — they differ only in volume.

Available options:
starter,
unlimited

Counts archived links too. Archiving never refunds the quota. Measured over quota_period_start when that is set, otherwise over all time.

null means unbounded.

quota_period_start
integer | null
required

Epoch ms. The window links_used and link_quota are measured over. Set only on the starter plan, where the allowance is per billing cycle; null means the quota is a lifetime total.

can_use_domains
boolean
required
can_see_analytics
boolean
required
trust
object
required