0.33.1 • Published 4 months ago

@polar-sh/sdk v0.33.1

Weekly downloads
-
License
-
Repository
github
Last release
4 months ago

@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://docs.polar.sh/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 zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

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

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "Polar": {
      "command": "npx",
      "args": [
        "-y", "--package", "@polar-sh/sdk",
        "--",
        "mcp", "start",
        "--access-token", "..."
      ]
    }
  }
}

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "Polar": {
      "command": "npx",
      "args": [
        "-y", "--package", "@polar-sh/sdk",
        "--",
        "mcp", "start",
        "--access-token", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package @polar-sh/sdk -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

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

const polar = new Polar();

async function run() {
  const result = await polar.endpointcheckoutCreatedPost({
    data: {
      createdAt: new Date("2023-02-15T15:44:21.478Z"),
      modifiedAt: new Date("2025-09-12T19:48:15.814Z"),
      id: "<value>",
      paymentProcessor: "stripe",
      status: "expired",
      clientSecret: "<value>",
      url: "https://fair-veto.com/",
      expiresAt: new Date("2025-03-15T14:26:53.109Z"),
      successUrl: "https://junior-linseed.net/",
      embedOrigin: "<value>",
      amount: 631188,
      discountAmount: 968968,
      netAmount: 929514,
      taxAmount: 323773,
      totalAmount: 115799,
      currency: "Som",
      productId: "<value>",
      productPriceId: "<value>",
      discountId: "<value>",
      allowDiscountCodes: true,
      requireBillingAddress: false,
      isDiscountApplicable: true,
      isFreeProductPrice: true,
      isPaymentRequired: true,
      isPaymentSetupRequired: true,
      isPaymentFormRequired: true,
      customerId: "<value>",
      isBusinessCustomer: true,
      customerName: "<value>",
      customerEmail: "<value>",
      customerIpAddress: "<value>",
      customerBillingName: "<value>",
      customerBillingAddress: {
        country: "US",
      },
      customerTaxId: "<id>",
      paymentProcessorMetadata: {},
      metadata: {
        "key": "<value>",
      },
      customerExternalId: "<id>",
      products: [],
      product: {
        createdAt: new Date("2025-03-29T00:34:40.708Z"),
        modifiedAt: new Date("2024-04-06T18:48:21.449Z"),
        id: "<value>",
        name: "<value>",
        description: "stall for mousse",
        recurringInterval: "year",
        isRecurring: false,
        isArchived: true,
        organizationId: "<value>",
        prices: [
          {
            createdAt: new Date("2023-09-13T08:36:46.434Z"),
            modifiedAt: new Date("2023-10-05T12:55:46.428Z"),
            id: "<value>",
            isArchived: false,
            productId: "<value>",
            recurringInterval: "month",
          },
          {
            createdAt: new Date("2024-05-02T18:25:33.974Z"),
            modifiedAt: new Date("2025-02-06T12:55:07.640Z"),
            id: "<value>",
            isArchived: false,
            productId: "<value>",
            type: "recurring",
            recurringInterval: "month",
            priceCurrency: "<value>",
            priceAmount: 115799,
          },
        ],
        benefits: [],
        medias: [
          {
            id: "<value>",
            organizationId: "<value>",
            name: "<value>",
            path: "/private/tmp",
            mimeType: "<value>",
            size: 225502,
            storageVersion: "<value>",
            checksumEtag: "<value>",
            checksumSha256Base64: "<value>",
            checksumSha256Hex: "<value>",
            lastModifiedAt: new Date("2024-07-06T07:35:44.280Z"),
            version: "<value>",
            isUploaded: true,
            createdAt: new Date("2024-10-08T20:45:26.653Z"),
            sizeReadable: "<value>",
            publicUrl: "https://graceful-battle.info",
          },
          {
            id: "<value>",
            organizationId: "<value>",
            name: "<value>",
            path: "/private/tmp",
            mimeType: "<value>",
            size: 225502,
            storageVersion: "<value>",
            checksumEtag: "<value>",
            checksumSha256Base64: "<value>",
            checksumSha256Hex: "<value>",
            lastModifiedAt: new Date("2024-07-06T07:35:44.280Z"),
            version: "<value>",
            isUploaded: true,
            createdAt: new Date("2024-10-08T20:45:26.653Z"),
            sizeReadable: "<value>",
            publicUrl: "https://graceful-battle.info",
          },
          {
            id: "<value>",
            organizationId: "<value>",
            name: "<value>",
            path: "/private/tmp",
            mimeType: "<value>",
            size: 225502,
            storageVersion: "<value>",
            checksumEtag: "<value>",
            checksumSha256Base64: "<value>",
            checksumSha256Hex: "<value>",
            lastModifiedAt: new Date("2024-07-06T07:35:44.280Z"),
            version: "<value>",
            isUploaded: true,
            createdAt: new Date("2024-10-08T20:45:26.653Z"),
            sizeReadable: "<value>",
            publicUrl: "https://graceful-battle.info",
          },
        ],
      },
      productPrice: {
        createdAt: new Date("2025-07-31T12:54:47.590Z"),
        modifiedAt: new Date("2023-01-11T22:31:47.320Z"),
        id: "<value>",
        isArchived: true,
        productId: "<value>",
        recurringInterval: "month",
        priceCurrency: "<value>",
        minimumAmount: 203013,
        maximumAmount: null,
        presetAmount: 119260,
      },
      discount: {
        duration: "once",
        type: "fixed",
        amount: 405691,
        currency: "Dobra",
        id: "<value>",
        name: "<value>",
        code: "<value>",
      },
      subscriptionId: "<value>",
      attachedCustomFields: [
        {
          customFieldId: "<value>",
          customField: {
            createdAt: new Date("2025-06-07T12:37:50.969Z"),
            modifiedAt: new Date("2023-11-20T09:37:39.033Z"),
            id: "<value>",
            metadata: {
              "key": true,
              "key1": "<value>",
              "key2": "<value>",
            },
            slug: "<value>",
            name: "<value>",
            organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
            properties: {},
          },
          order: 168537,
          required: false,
        },
      ],
      customerMetadata: {
        "key": true,
        "key1": false,
        "key2": 851435,
      },
      customerBillingAddressFields: {
        country: false,
        state: true,
        city: false,
        postalCode: true,
        line1: true,
        line2: false,
      },
    },
  });

  console.log(result);
}

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

benefits

checkoutLinks

  • list - List Checkout Links
  • create - Create Checkout Link
  • get - Get Checkout Link
  • update - Update Checkout Link
  • delete - Delete 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

customerMeters

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

customerPortal

customerPortal.benefitGrants

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

customerPortal.customerMeters

  • list - List Meters
  • get - Get Customer Meter

customerPortal.customers

customerPortal.downloadables

  • list - List Downloadables
  • get - Get Downloadable

customerPortal.licenseKeys

customerPortal.orders

customerPortal.organizations

  • get - Get Organization

customerPortal.subscriptions

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

customers

customerSessions

  • create - Create Customer Session

customFields

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

discounts

events

files

licenseKeys

meters

metrics

oauth2

oauth2.clients

orders

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
  • export - Export Subscriptions
  • get - Get Subscription
  • update - Update Subscription
  • revoke - Revoke Subscription

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:

PropertyTypeDescription
error.messagestringError message
error.statusCodenumberHTTP response status code eg 404
error.headersHeadersHTTP response headers
error.bodystringHTTP body. Can be empty string if no body is returned.
error.rawResponseResponseRaw 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 66 of 121 methods.*
  • NotPermitted: Status code 403. Applicable to 9 of 121 methods.*
  • Unauthorized: Not authorized to manage license key. Status code 401. Applicable to 5 of 121 methods.*
  • AlreadyCanceledSubscription: Status code 403. Applicable to 4 of 121 methods.*
  • AlreadyActiveSubscriptionError: The checkout is expired or the customer already has an active subscription. Status code 403. Applicable to 3 of 121 methods.*
  • NotOpenCheckout: The checkout is expired or the customer already has an active subscription. Status code 403. Applicable to 3 of 121 methods.*
  • ExpiredCheckoutError: The checkout session is expired. Status code 410. Applicable to 3 of 121 methods.*
  • InvoiceAlreadyExists: Order already has an invoice. Status code 409. Applicable to 2 of 121 methods.*
  • MissingInvoiceBillingDetails: Order is not paid or is missing billing name or address. Status code 422. Applicable to 2 of 121 methods.*
  • NotPaidOrder: Order is not paid or is missing billing name or address. Status code 422. Applicable to 2 of 121 methods.*
  • RefundAmountTooHigh: Refund amount exceeds remaining order balance. Status code 400. Applicable to 1 of 121 methods.*
  • PaymentError: The payment failed. Status code 400. Applicable to 1 of 121 methods.*
  • RefundedAlready: Order is already fully refunded. Status code 403. Applicable to 1 of 121 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:

NameServerDescription
productionhttps://api.polar.shProduction environment
sandboxhttps://sandbox-api.polar.shSandbox environment

Example

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

const polar = new Polar({
  server: "sandbox",
  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 use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

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

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

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 });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

NameTypeSchemeEnvironment Variable
accessTokenhttpHTTP BearerPOLAR_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({
    customerSession: process.env["POLAR_CUSTOMER_SESSION"] ?? "",
  }, {
    organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  });

  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

standardwebhooks
@everything-registry/sub-chunk-730@convex-dev/polarpolar-sveltekitpolar-initpolar-migratecheckout-link@erquhart/convex-polar@paykit-sdk/polar@polar-sh/adapter-utils@polar-sh/astro@polar-sh/checkout@polar-sh/elysia@polar-sh/express@polar-sh/fastify@polar-sh/hono@polar-sh/ingestion@polar-sh/nextjs@polar-sh/nuxt@polar-sh/remix@polar-sh/sveltekit@polar-sh/tanstack-start
0.20.1

10 months ago

0.20.0

10 months ago

0.32.8

6 months ago

0.19.0

10 months ago

0.17.2

11 months ago

0.32.7

7 months ago

0.19.1

10 months ago

0.17.3

11 months ago

0.19.2

10 months ago

0.17.4

11 months ago

0.32.5

7 months ago

0.32.4

7 months ago

0.32.3

7 months ago

0.32.2

7 months ago

0.32.1

7 months ago

0.15.0

12 months ago

0.15.1

12 months ago

0.17.0

11 months ago

0.32.9

6 months ago

0.17.1

11 months ago

0.32.0

7 months ago

0.30.0

8 months ago

0.29.0

8 months ago

0.27.1

8 months ago

0.27.0

8 months ago

0.25.1

8 months ago

0.25.0

9 months ago

0.21.3

9 months ago

0.23.0

9 months ago

0.21.2

9 months ago

0.21.1

9 months ago

0.32.16

5 months ago

0.32.15

5 months ago

0.32.14

5 months ago

0.32.13

6 months ago

0.32.12

6 months ago

0.29.3

8 months ago

0.32.11

6 months ago

0.29.2

8 months ago

0.32.10

6 months ago

0.29.1

8 months ago

0.21.0

9 months ago

0.18.1

10 months ago

0.33.1

4 months ago

0.33.0

5 months ago

0.14.0

12 months ago

0.16.0

12 months ago

0.16.1

11 months ago

0.18.0

11 months ago

0.16.2

11 months ago

0.31.0

7 months ago

0.28.0

8 months ago

0.26.1

8 months ago

0.26.0

8 months ago

0.24.0

9 months ago

0.22.2

9 months ago

0.22.1

9 months ago

0.22.0

9 months ago

0.20.2

10 months ago

0.13.5

12 months ago

0.13.4

1 year ago

0.13.3

1 year ago

0.13.2

1 year ago

0.13.1

1 year ago

0.11.0

1 year ago

0.12.0

1 year ago

0.11.1

1 year ago

0.13.0

1 year ago

0.10.0

1 year ago

0.9.0

1 year ago

0.8.1

1 year ago

0.8.2

1 year ago

0.8.0

1 year ago

0.7.1

1 year ago

0.7.0

1 year ago

0.6.1

1 year ago

0.5.2

1 year ago

0.5.1

1 year ago

0.5.0

2 years ago

0.4.8

2 years ago

0.4.5

2 years ago

0.4.6

2 years ago

0.4.0

2 years ago

0.3.0

2 years ago

0.2.0

2 years ago

0.1.1

2 years ago

0.1.0

2 years ago