API Reference
Use this reference to check the request, authentication, and response contract for auth, billing, user access, webhook, and health routes.
Route families
Authentication API
7 endpoints. Sign up, sign in, configure OAuth, and update an account through Supabase Auth.
Read more
Billing API
2 endpoints. Create checkout sessions and open authenticated billing management.
Read more
Health API
1 endpoint. Health checks for local and deployed runtime checks.
Read more
User API
2 endpoints. Read the current session, billing access, and subscription status.
Read more
Webhook API
2 endpoints. Receive signed Stripe or Polar events and keep billing state in sync.
Read more
Each endpoint page includes the route, request body, authentication requirements, cURL example, and response examples. Copy the cURL examples into your terminal; the Docs do not run requests from the browser.
Runtime notes
| Area | What to check |
|---|---|
| Auth and user routes | Browser session cookies decide the current user and billing access. |
| Billing routes | Checkout and portal routes run server-side so provider secrets stay out of the browser. |
| Webhooks | Providers send signed events to their webhook routes; use the matching provider CLI or dashboard when testing. |
For required provider keys and local defaults, see Configure Environment. For common product questions, see Frequently Asked Questions.
Was this page helpful?