Superwall API

Call the Superwall REST API with an organization API key, the same API the MCP, CLI, and Superwall AI use.

The Superwall API is the REST API behind the dashboard, the Superwall MCP, the Superwall CLI, and Superwall AI. Use it directly when you're building your own integration or script.

If you're working with an AI agent, you usually don't need to call the API yourself. The plugin, MCP, and CLI already use it with your account's permissions.

Reference

The full reference, with every endpoint and its parameters, is at api.superwall.com/docs. The OpenAPI spec is at api.superwall.com/openapi.json. You can give either one to an agent so it can write requests for you.

The base URL is https://api.superwall.com, and endpoints are versioned under /v2, for example /v2/projects and /v2/products.

Authentication

Requests use an organization API key as a bearer token:

curl https://api.superwall.com/v2/projects \
  -H "Authorization: Bearer $SUPERWALL_API_KEY"

Create keys in the dashboard under Settings › API Keys. Each key has scopes, which control the resources it can read or write, and project access, which controls the projects it can reach. See API key access.

From the CLI

The CLI can make authenticated API calls using your superwall login session, so you don't need a key:

superwall get /v2/products
superwall post /v2/products -d project_id=<project-id> -d identifier=pro_monthly -d name="Pro Monthly" -d 'price[amount]:=9.99' -d 'price[currency]=USD'

See Call the API in the CLI guide.

Analytics queries

To run SQL against your analytics data, use superwall query or the ClickHouse query API.

How is this guide?

On this page