Overview
Everything a developer needs to build an app on Prebit.
Everything you need to build an app on Prebit: an externally-hosted backend (any language, any host) that talks to a merchant's store over the Partner API, plus an optional in-storefront extension via the Extension Runtime.
This is real, accurate documentation of what's built and callable today (2026-07-23) — not a roadmap. Where something is designed but not yet callable, that's stated explicitly rather than glossed over. Two corrections worth knowing up front, covered in full on their own pages:
Billing has no Partner-API-callable endpoint
A merchant subscribing to your billing = "prebit" app is entirely
merchant-dashboard-initiated. There is no POST /platform/v1/billing/...
you call. See Billing.
Extension Runtime is real, not a design doc
Unlike some early drafts of this platform's architecture, the Extension
Runtime's runtime.* API is genuinely implemented (Phases 1–4) — it has
just never been exercised against a real deployed extension or
production traffic yet. See Extension Runtime.
Where to start
- New to Prebit apps? Start with Getting Started.
- Already have an app registered? Jump to OAuth to get your first access token, or straight to the API reference.
- Want to see it working before reading anything? Clone
prebit-app-template-nextor runprebit-examples.
The ecosystem
| Repo | What it is |
|---|---|
prebit-sdk (@prebit/sdk) | The official Node client — API methods, OAuth/PKCE helpers, webhook verification. |
prebit-cli (prebit) | create, login, dev, build, publish, webhook listen. |
create-prebit-app | npx create-prebit-app — scaffolds from the official starter. |
prebit-app-template-next | The official Next.js starter: real OAuth callback + webhook receiver. |
prebit-examples | Five copy-paste example apps. |
prebit-docs | This site. |
Base URL
All API paths in this documentation are relative to your Prebit
environment's host, e.g. https://admin.prebit.in in production. There is
no separate api. host — Partner API v1 lives at /api/platform/v1/...
on the same host as OAuth and the Developer Portal.
Conventions used throughout
Bearer <access_token>on every Partner API v1 call — see Authentication and OAuth.- Every write requires an
Idempotency-Keyheader — see Errors, Pagination & Idempotency. - List endpoints are cursor-paginated:
?cursor=<id>&limit=<n>in,{ items, nextCursor }shaped out. - Every response is JSON. Errors are always
{ "error": "<message>" }(sometimes with extra fields likeissues/warnings), with a matching HTTP status code. - Every API reference page shows both a
curl(REST) view and a@prebit/sdk(TypeScript) view for each call — use whichever matches how you're building.