Skip to content

Auth + plan introspection

GET
/v1/setup-check

Returns the project, plan, feature flags, and remaining quota for the bearer’s API key. Call this first on every integration to verify your key is valid and confirm which features are enabled on your plan.

Auth: Secret key (nv_live_* or nv_test_*).

Setup info

object
data
required
object
project_id
required
string
/^prj_[0-9A-HJKMNP-TV-Z]{26}$/
project_slug
required
string
project_name
required
string
plan
required
string
Allowed values: free indie builder
features_enabled
required
object
changelog
required
boolean
waitlist
required
boolean
feedback
required
boolean
notifications
required
boolean
email_notifications
required
boolean
custom_domain
required
boolean
limits
required
object
changelog_entries_remaining
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
subscribers_max
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
plan_details
required
object
description
required
string
locked_features
required
Array<string>
upgrade_url
required
Any of:
string format: uri
changelog_public_url
required
string format: uri
error
required
null
meta
object
key
additional properties

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties