Skip to content

Get a plan by key

GET
/v1/plans/{plan_key}
curl --request GET \
--url https://api.seal0.app/v1/plans/example \
--header 'Authorization: Bearer <token>'
plan_key
required
string

The plan.

Media typeapplication/json
object
created_at
required
string format: date-time
has_draft
required

Whether the plan has an unpublished draft.

boolean
id
required
string
key
required

Feature or plan key.

string
/^[a-z][a-z0-9_]{0,63}$/
name
required
string
updated_at
required
string format: date-time

Example generated

{
"created_at": "2026-04-15T12:00:00Z",
"has_draft": true,
"id": "example",
"key": "example",
"name": "example",
"updated_at": "2026-04-15T12:00:00Z"
}

Error envelope.

Media typeapplication/json
object
error
required
object
code
required

Stable snake_case error code.

string
field
required

Offending input field, when known.

string
nullable
message
required
string
request_id
required
string

Example generated

{
"error": {
"code": "example",
"field": "example",
"message": "example",
"request_id": "example"
}
}

Error envelope.

Media typeapplication/json
object
error
required
object
code
required

Stable snake_case error code.

string
field
required

Offending input field, when known.

string
nullable
message
required
string
request_id
required
string

Example generated

{
"error": {
"code": "example",
"field": "example",
"message": "example",
"request_id": "example"
}
}

Error envelope.

Media typeapplication/json
object
error
required
object
code
required

Stable snake_case error code.

string
field
required

Offending input field, when known.

string
nullable
message
required
string
request_id
required
string

Example generated

{
"error": {
"code": "example",
"field": "example",
"message": "example",
"request_id": "example"
}
}

Error envelope.

Media typeapplication/json
object
error
required
object
code
required

Stable snake_case error code.

string
field
required

Offending input field, when known.

string
nullable
message
required
string
request_id
required
string

Example generated

{
"error": {
"code": "example",
"field": "example",
"message": "example",
"request_id": "example"
}
}