概述

PaymentKit Node.js SDK 为你的 Node.js 应用与 PaymentKit API 的集成提供了一个直接且高效的接口。它旨在简化客户、订阅、产品、支付和复杂的基于信用的计费系统的管理，让你能够专注于核心应用逻辑。

该 SDK 以 NPM 包 的形式提供，并使用 TypeScript 完全类型化，通过自动补全和编译时错误检查提供卓越的开发体验。

工作原理#

该 SDK 作为 PaymentKit REST API 的一个便捷封装。你的应用程序初始化 SDK 客户端，然后由客户端处理与各种 API 资源交互所需的身份验证和通信。

核心功能#

全面的资源管理

轻松对基本资源执行 CRUD（创建、读取、更新、删除）操作：

• 客户：管理你的用户群。
• 产品与价格：定义你销售的商品及其定价方式。
• 订阅：处理周期性计费和订阅生命周期。
• 支付：创建和管理支付意图。

灵活的结账流程

为一次性支付和订阅创建安全且可定制的结账会话。将客户重定向到由 PaymentKit 托管的页面以完成购买，然后使用 success_url 和 cancel_url 将他们引导回你的应用程序。

高级的基于信用的计费

通过强大的信用系统实现基于使用量的计费模型：

• 计量器：跟踪任何资源的消耗，例如 API 调用、数据存储或计算时间。你可以定义聚合方法，如 sum、count 或 last。
• 信用授权：向客户发放信用。信用可以购买（paid）或免费赠送（promotional）。
• 计量事件：从你的应用程序报告使用事件。系统会自动从客户的信用余额中扣除相应金额。
• 余额与交易：以编程方式检查客户的信用余额并查看其交易历史。

通过 Webhooks 实现实时通知

配置 Webhook 端点以接收关于你 PaymentKit 账户中发生的事件的实时通知。这使你的应用程序能够自动对以下事件做出反应：

• checkout.session.completed
• customer.subscription.created
• payment_intent.succeeded

现在你已经对该 SDK 的功能有了大致了解，可以准备设置环境并开始实施了。

接下来，请前往 快速入门 指南来安装 SDK 并进行你的首次 API 调用。