TypeScript SDK

The official TypeScript SDK provides a fully typed client for the Polar API.

Installation

npm
yarn
pnpm

Terminal

npm install @polar-sh/sdk

Terminal

yarn add @polar-sh/sdk

Terminal

pnpm add @polar-sh/sdk

Quickstart

Create an organization access token for server-side use, keep it out of browser bundles, store it in POLAR_ACCESS_TOKEN, and make your first request:

index.js

import { createPolar } from "@polar-sh/sdk/2026-04";

const polar = createPolar({
  accessToken: process.env.POLAR_ACCESS_TOKEN!,
});

const customerState = await polar.customers.getStateExternal("customer_external_id");
console.log(customerState);

The import path pins your client to the 2026-04 API version.

Sandbox environment

The client uses production by default. Pass environment: "sandbox" to use the isolated sandbox environment:

const polar = createPolar({
  accessToken: process.env.POLAR_ACCESS_TOKEN!,
  environment: "sandbox",
});

View the source code on GitHub.

Framework adapters

Implement Checkout & Webhook handlers in few lines of code.

Adapters for other frameworks are deprecated, use the SDK directly instead. The polar-integration skill can help you integrate or migrate:

npx skills add https://github.com/polarsource/skills --skill polar-integration

Bootup

Features

Integrate

Merchant of Record (MoR)

TypeScript SDK

Installation

Quickstart

Sandbox environment

Framework adapters

​Installation

​Quickstart

​Sandbox environment

​Framework adapters

Installation

Quickstart

Sandbox environment

Framework adapters