@useairfoil/producer-polar

中文文档
0.3.2发布于 2026/11/03TypeScriptES Module构建来源已验证

This connector backfills Polar customers, checkouts, orders, subscriptions, refunds, products, and discounts. It gets live events at POST /webhooks/polar.

原始使用文档
文档目录6 节
  1. Config
  2. Setup
  3. API version
  4. Limits
  5. Demo data
  6. Local development

Polar producer

This connector backfills Polar customers, checkouts, orders, subscriptions, refunds, products, and discounts. It gets live events at POST /webhooks/polar.

Config

VariableRequiredDefault
POLAR_ACCESS_TOKENyesnone
POLAR_WEBHOOK_SECRETyesnone
POLAR_API_BASE_URLhosted onlynone
POLAR_ORGANIZATION_IDnonone

Setup

Create a Polar organization access token with customers:read, checkouts:read, orders:read, subscriptions:read, refunds:read, products:read, and discounts:read. Use it as POLAR_ACCESS_TOKEN.

Create a webhook endpoint for /webhooks/polar and use its signing secret as POLAR_WEBHOOK_SECRET. Sandbox tokens and webhooks must come from the Polar sandbox. Subscribe it to the customer.*, checkout.*, order.*, subscription.*, refund.*, product.*, and discount.* events. The connector acknowledges other events without storing them.

API version

The connector pins Polar API version 2026-10 with the Polar-Version header. Set the webhook endpoint API version to 2026-10.

Limits

Deleted products stay in the products table because Polar has no product.deleted webhook. Subscriptions without started_at can be missed during a backfill because Polar has no stable sort for them. After backfill, updates depend on webhooks. Missed webhook deliveries are not recovered yet.

Demo data

pnpm demo --size 128MiB writes made-up Polar data without a Polar token. See the Connector Kit README for the flags and the variables it needs.

Each customer has checkouts, subscriptions, orders, and refunds that point to each other and to a fixed catalog of 6 products and 3 discounts. products and discounts don't grow with the size.

Local development

The sandbox uses the Polar sandbox API.

cd connectors/producer-polar
pnpm sandbox

A hosted run loads connector config from AIRFOIL_CONFIG_PATH. It also needs the Wings and PostgreSQL variables from the Connector Kit README.

cd connectors/producer-polar
pnpm start

版本与发布记录

@useairfoil/producer-polar 共发布 6 个版本,首次发布于 2026/08/14;过去 12 个月发布了 6 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.3.2latest2026/11/03今天
0.3.12026/10/295 天前
0.3.02026/08/252 个月前
0.2.22026/08/142 个月前
0.2.12026/08/142 个月前
0.0.12026/08/142 个月前

关于 @useairfoil/producer-polar 的常见问题

@useairfoil/producer-polar 是什么?

该连接器将填充Polar客户、结帐、订单、订阅、退款、产品和折扣。它有现场活动 POST /webhooks/polar.

如何安装 @useairfoil/producer-polar?

在项目目录运行 npm install @useairfoil/producer-polar,或使用 pnpm add / yarn add / bun add。

@useairfoil/producer-polar 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@useairfoil/producer-polar 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@useairfoil/producer-polar 可以商用吗?

@useairfoil/producer-polar 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@useairfoil/producer-polar 还在维护吗?

最新版本 0.3.2 发布于 2026/11/03(今天);至今共发布 6 个版本,其中过去 12 个月发布了 6 个;首次发布于 2026/08/14。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。