Skip to main content
GET
Preview what deploying would change about the schema

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

id
string
required

The resource ID (e.g., "prod_abc123") or slug (e.g., "my-product")

Response

Planned schema change

object
string
up_to_date
boolean

The live database already matches; deploying would change nothing.

summary
string[]

What the change means, in language a non-technical merchant can act on.

statements
string[]

The DDL that would run.

notes
string[]

Anything that would be removed or rebuilt.

destructive
boolean
sql
string | null