npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@polar-sh/sdk

v0.46.3

Published

Developer-friendly & type-safe Typescript SDK specifically catered to leverage [Polar](https://polar.sh) API.

Downloads

461,737

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

birkjernstrombirkjernstromemilwidlundemilwidlundfvoronfvoron

Keywords

Readme

@polar-sh/sdk

Developer-friendly & type-safe Typescript SDK specifically catered to leverage Polar API.

[!WARNING] Starting version >v0.6.0, we changed our SDK generator. It's not backward compatible with previous versions.

Summary

Polar API: Polar HTTP and Webhooks API

Read the docs at https://polar.sh/docs/api-reference

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @polar-sh/sdk

PNPM

pnpm add @polar-sh/sdk

Bun

bun add @polar-sh/sdk

Yarn

yarn add @polar-sh/sdk

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.organizations.list({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

Webhook support

The SDK has built-in support to validate webhook events. Here is an example with Express.js:

import express, { Request, Response } from "express";
import { validateEvent, WebhookVerificationError } from "@polar-sh/sdk/webhooks";

const app = express();

app.post("/webhook", express.raw({ type: "application/json" }), (req: Request, res: Response) => {
  try {
    const event = validateEvent(req.body, req.headers, process.env["POLAR_WEBHOOK_SECRET"] ?? "");

    // Process the event

    res.status(202).send('')
  } catch (error) {
    if (error instanceof WebhookVerificationError) {
      res.status(403).send('')
    }
    throw error
  }
});

Available Resources and Operations

BenefitGrants

  • list - List Benefit Grants

Benefits

CheckoutLinks

  • list - List Checkout Links
  • create - Create Checkout Link
  • get - Get Checkout Link
  • delete - Delete Checkout Link
  • update - Update Checkout Link

Checkouts

  • list - List Checkout Sessions
  • create - Create Checkout Session
  • get - Get Checkout Session
  • update - Update Checkout Session
  • clientGet - Get Checkout Session from Client
  • clientUpdate - Update Checkout Session from Client
  • clientConfirm - Confirm Checkout Session from Client

CustomFields

  • list - List Custom Fields
  • create - Create Custom Field
  • get - Get Custom Field
  • delete - Delete Custom Field
  • update - Update Custom Field

CustomerMeters

  • list - List Customer Meters
  • get - Get Customer Meter

CustomerPortal.BenefitGrants

  • list - List Benefit Grants
  • get - Get Benefit Grant
  • update - Update Benefit Grant

CustomerPortal.CustomerMeters

  • list - List Meters
  • get - Get Customer Meter

CustomerPortal.CustomerSession

CustomerPortal.Customers

CustomerPortal.Downloadables

  • list - List Downloadables

CustomerPortal.LicenseKeys

CustomerPortal.Members

CustomerPortal.Orders

CustomerPortal.Organizations

  • get - Get Organization

CustomerPortal.Seats

CustomerPortal.Subscriptions

  • list - List Subscriptions
  • get - Get Subscription
  • cancel - Cancel Subscription
  • update - Update Subscription

CustomerPortal.Wallets

  • list - List Wallets
  • get - Get Wallet

CustomerSeats

CustomerSessions

  • create - Create Customer Session

Customers

Discounts

Disputes

  • list - List Disputes
  • get - Get Dispute

EventTypes

Events

Files

LicenseKeys

Members

Meters

Metrics

Oauth2

Oauth2.Clients

Orders

OrganizationAccessTokens

Organizations

  • list - List Organizations
  • create - Create Organization
  • get - Get Organization
  • update - Update Organization

Payments

  • list - List Payments
  • get - Get Payment

Products

Refunds

Subscriptions

  • list - List Subscriptions
  • create - Create Subscription
  • export - Export Subscriptions
  • get - Get Subscription
  • revoke - Revoke Subscription
  • update - Update Subscription

Webhooks

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.organizations.list({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.organizations.list({}, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.organizations.list({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

Error Handling

PolarError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Polar } from "@polar-sh/sdk";
import { HTTPValidationError } from "@polar-sh/sdk/models/errors/httpvalidationerror.js";
import { PolarError } from "@polar-sh/sdk/models/errors/polarerror.js.js";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  try {
    const result = await polar.organizations.list({});

    for await (const page of result) {
      console.log(page);
    }
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof PolarError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof HTTPValidationError) {
        console.log(error.data$.detail); // ValidationError[]
      }
    }
  }
}

run();

Error Classes

Primary errors:

Network errors:

Inherit from PolarError:

  • ResourceNotFound: Status code 404. Applicable to 82 of 169 methods.*
  • NotPermitted: Status code 403. Applicable to 10 of 169 methods.*
  • Unauthorized: Not authorized to manage license key. Status code 401. Applicable to 5 of 169 methods.*
  • AlreadyCanceledSubscription: Status code 403. Applicable to 4 of 169 methods.*
  • AlreadyActiveSubscriptionError: The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments. Status code 403. Applicable to 3 of 169 methods.*
  • NotOpenCheckout: The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments. Status code 403. Applicable to 3 of 169 methods.*
  • PaymentNotReady: The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments. Status code 403. Applicable to 3 of 169 methods.*
  • TrialAlreadyRedeemed: The checkout is expired, the customer already has an active subscription, or the organization is not ready to accept payments. Status code 403. Applicable to 3 of 169 methods.*
  • ExpiredCheckoutError: The checkout session is expired. Status code 410. Applicable to 3 of 169 methods.*
  • SubscriptionLocked: Subscription is pending an update. Status code 409. Applicable to 2 of 169 methods.*
  • MissingInvoiceBillingDetails: Order is not paid or is missing billing name or address. Status code 422. Applicable to 2 of 169 methods.*
  • NotPaidOrder: Order is not paid or is missing billing name or address. Status code 422. Applicable to 2 of 169 methods.*
  • PaymentError: The payment failed. Status code 400. Applicable to 1 of 169 methods.*
  • CustomerNotReady: Customer is not ready to confirm a payment method. Status code 400. Applicable to 1 of 169 methods.*
  • PaymentMethodInUseByActiveSubscription: Payment method is used by active subscription(s). Status code 400. Applicable to 1 of 169 methods.*
  • RefundedAlready: Order is already fully refunded. Status code 403. Applicable to 1 of 169 methods.*
  • PaymentAlreadyInProgress: Payment already in progress. Status code 409. Applicable to 1 of 169 methods.*
  • OrderNotEligibleForRetry: Order not eligible for retry or payment confirmation failed. Status code 422. Applicable to 1 of 169 methods.*
  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Name

You can override the default server globally by passing a server name to the server: keyof typeof ServerList optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

| Name | Server | Description | | ------------ | ------------------------------ | ---------------------- | | production | https://api.polar.sh | Production environment | | sandbox | https://sandbox-api.polar.sh | Sandbox environment |

Example

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  server: "production",
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.organizations.list({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  serverURL: "https://api.polar.sh",
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.organizations.list({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

  • route requests through a proxy server using undici's ProxyAgent
  • use the "beforeRequest" hook to add a custom header and a timeout to requests
  • use the "requestError" hook to log errors
import { Polar } from "@polar-sh/sdk";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@polar-sh/sdk/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Polar({ httpClient: httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | ------------- | ---- | ----------- | -------------------- | | accessToken | http | HTTP Bearer | POLAR_ACCESS_TOKEN |

To authenticate with the API the accessToken parameter must be set when initializing the SDK client instance. For example:

import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.organizations.list({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import { Polar } from "@polar-sh/sdk";

const polar = new Polar();

async function run() {
  const result = await polar.customerPortal.benefitGrants.list({}, {});

  for await (const page of result) {
    console.log(page);
  }
}

run();

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Polar } from "@polar-sh/sdk";

const sdk = new Polar({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable POLAR_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy