# @deliverart/sdk-js-subscription 中文文档

规范地址：https://npmcn.com/package/%40deliverart/sdk-js-subscription/

版本：3\.0\.1
npm 元数据更新时间：2026-11-10T20:26:24.865Z
中文译文更新时间：2026-11-12T04:41:29.279Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40deliverart/sdk-js-subscription
原文对照：https://npmcn.com/package/%40deliverart/sdk-js-subscription/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.2 MB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2026-03-24T09:42:05.290Z
- 最新版本发布：2026-11-10T20:26:24.712Z
- 近 30 天下载量：2914（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：125（近 12 个月 125 个）

## 中文简介

为订阅管理交付JavaScript SDK

## 安装

```sh
npm install @deliverart/sdk-js-subscription
```

也可以使用：`pnpm add @deliverart/sdk-js-subscription`、`yarn add @deliverart/sdk-js-subscription`、`bun add @deliverart/sdk-js-subscription`

## README

# @ deliverart/ sdk- js 订阅

交付JavaScript SDK的订阅管理软件包.

## 要点

-   后台/admin流量的订阅计划 CRUD
-   可购买订阅计划公共目录
-   初始订阅购买流程,支付启动和离线支付解决方案
-   订阅 CRUD 用于 `infinite`, (中文(简体) ), `consumption` 财务报告和审定财务报表 `time_based`
-   更新 CRUD 用于 `consumption` 财务报告和审定财务报表 `time_based`
-   从销售点看订阅概况
-   管理计费队列和计费概况
-   消费认购信贷调整
-   延期付款初始化 `stripe` 财务报告和审定财务报表 `bank_transfer`
-   手动更新离线支付方法的付款解决方案
-   购买生命周期动作: `cancel`, (中文(简体) ), `retry_payment`, (中文(简体) ), `refund`
-   更新生命周期行动: `cancel`, (中文(简体) ), `retry_payment`, (中文(简体) ), `refund`

## 订阅计划目录

```ts
import { GetSubscriptionPlanCatalog } from '@deliverart/sdk-js-subscription'

const plans = await sdk.call(new GetSubscriptionPlanCatalog())
```

每个目录项都显示计划配置加 `priceOptions`,已按阈值排序.

在创建购买前预览自助收费 :

```ts
import { CalculateSubscriptionPlanPurchaseQuote } from '@deliverart/sdk-js-subscription'

const quote = await sdk.call(
  new CalculateSubscriptionPlanPurchaseQuote('plan-id', {
    pointOfSale: '/point_of_sales/pos-id',
    startsAt: '2026-04-05',
  }),
)
```

答复包括: `threshold`, (中文(简体) ), `unitPrice`, (中文(简体) ), `amount`, (中文(简体) ), `type`, (中文(简体) ), `startsAt` 联合国 `autoRenewal`。 。 。 .

## 管理计划分配

将计划直接分配给销售点,而不经过公共购买流程:

```ts
import { AssignSubscriptionPlan } from '@deliverart/sdk-js-subscription'

const subscription = await sdk.call(
  new AssignSubscriptionPlan('plan-id', {
    pointOfSale: '/point_of_sales/pos-id',
    startsAt: '2026-04-01',
  }),
)
```

这项行动是为了管理/后台流动,包括 `adminOnly` 财务报告和审定财务报表 `infinite` 计划.

## 订阅

从公共计划中创建购买:

```ts
import { CreateSubscriptionPurchase } from '@deliverart/sdk-js-subscription'

const purchase = await sdk.call(
  new CreateSubscriptionPurchase({
    pointOfSale: '/point_of_sales/pos-id',
    plan: '/subscription_plans/plan-id',
  }),
)
```

开始购买付款 :

```ts
import { PaySubscriptionPurchase } from '@deliverart/sdk-js-subscription'

const payment = await sdk.call(
  new PaySubscriptionPurchase('purchase-id', 'bank_transfer'),
)
```

订阅帐单为平台级别:

-   订单和电子商务支付仍然使用每个POS支付配置
-   订阅购买和续订使用中央平台计费账户
-   因此,SDK只接受 `stripe` 财务报告和审定财务报表 `bank_transfer` 用于开始和重试订阅付款

解决离线支付 :

```ts
import { ResolveSubscriptionPurchasePayment } from '@deliverart/sdk-js-subscription'

await sdk.call(
  new ResolveSubscriptionPurchasePayment('purchase-id', {
    status: 'paid',
    response: 'verified by admin',
  }),
)
```

对于 `bank_transfer`,购买或更新移动到 `pending_verification` 直至a `ROLE_SUBSCRIPTION_BILLING_ADMIN`, (中文(简体) ), `ROLE_SUBSCRIPTION_ADMIN` 或者说 `ROLE_SUPER_ADMIN` 同意或拒绝它.

取消未完成的购买 :

```ts
import { CancelSubscriptionPurchase } from '@deliverart/sdk-js-subscription'

await sdk.call(
  new CancelSubscriptionPurchase('purchase-id', {
    response: 'customer cancelled before payment',
  }),
)
```

重试一次失败的购买付款 :

```ts
import { RetrySubscriptionPurchasePayment } from '@deliverart/sdk-js-subscription'

const payment = await sdk.call(
  new RetrySubscriptionPurchasePayment('purchase-id', 'bank_transfer'),
)
```

如果重试方法是 `bank_transfer`,返回的购买状态变为 `pending_verification`。 。 。 .

退还已完成的离线采购:

```ts
import { RefundSubscriptionPurchase } from '@deliverart/sdk-js-subscription'

await sdk.call(
  new RefundSubscriptionPurchase('purchase-id', {
    response: 'manual refund approved',
  }),
)
```

## 更新支付开始

消费更新:

```ts
import { PaySubscriptionConsumptionRenewal } from '@deliverart/sdk-js-subscription'

const payment = await sdk.call(
  new PaySubscriptionConsumptionRenewal('renewal-id', 'bank_transfer'),
)
```

时间更新:

```ts
import { PaySubscriptionTimeBasedRenewal } from '@deliverart/sdk-js-subscription'

const payment = await sdk.call(
  new PaySubscriptionTimeBasedRenewal('renewal-id', 'stripe'),
)
```

两个请求都退回 `PaymentInfo` 用于支付 SDK 区域的形状.

## 续约付款解决

消费更新:

```ts
import { ResolveSubscriptionConsumptionRenewalPayment } from '@deliverart/sdk-js-subscription'

await sdk.call(
  new ResolveSubscriptionConsumptionRenewalPayment('renewal-id', {
    status: 'paid',
    response: 'verified by admin',
  }),
)
```

时间更新:

```ts
import { ResolveSubscriptionTimeBasedRenewalPayment } from '@deliverart/sdk-js-subscription'

await sdk.call(
  new ResolveSubscriptionTimeBasedRenewalPayment('renewal-id', {
    status: 'failed',
    response: 'bank transfer rejected',
  }),
)
```

允许状态为 `paid`, (中文(简体) ), `failed` 财务报告和审定财务报表 `canceled`。 。 。 .

续约通常必须在 `pending_verification` 在人工批准之前.

## 管理计费阅读模式

待核查队列 :

```ts
import { GetSubscriptionBillingPendingVerification } from '@deliverart/sdk-js-subscription'

const queue = await sdk.call(
  new GetSubscriptionBillingPendingVerification({
    query: {
      kind: 'purchase',
      olderThanHours: 24,
      limit: 20,
    },
  }),
)
```

帐单概览计数器:

```ts
import { GetSubscriptionBillingOverview } from '@deliverart/sdk-js-subscription'

const overview = await sdk.call(new GetSubscriptionBillingOverview())
```

总体有效载荷暴露于:

-   有待核实的采购和延期清点
-   付款计数失败
-   开放式采购清点
-   等待延期的计数
-   (单位:千美元) `queuePreview` 由待定的校验队列返回相同项目形状的阵列

## 寿命周期动作

消费更新:

```ts
import {
  CancelSubscriptionConsumptionRenewal,
  RetrySubscriptionConsumptionRenewalPayment,
  RefundSubscriptionConsumptionRenewal,
} from '@deliverart/sdk-js-subscription'

await sdk.call(
  new CancelSubscriptionConsumptionRenewal('renewal-id', {
    response: 'operator canceled renewal',
  }),
)

const payment = await sdk.call(
  new RetrySubscriptionConsumptionRenewalPayment('renewal-id', 'bank_transfer'),
)

await sdk.call(
  new RefundSubscriptionConsumptionRenewal('renewal-id', {
    response: 'manual credit refund',
  }),
)
```

时间更新:

```ts
import {
  CancelSubscriptionTimeBasedRenewal,
  RetrySubscriptionTimeBasedRenewalPayment,
  RefundSubscriptionTimeBasedRenewal,
} from '@deliverart/sdk-js-subscription'

await sdk.call(
  new CancelSubscriptionTimeBasedRenewal('renewal-id', {
    response: 'operator canceled renewal',
  }),
)

const payment = await sdk.call(
  new RetrySubscriptionTimeBasedRenewalPayment('renewal-id', 'bank_transfer'),
)

await sdk.call(
  new RefundSubscriptionTimeBasedRenewal('renewal-id', {
    response: 'manual time-based refund',
  }),
)
```

`cancel` 财务报告和审定财务报表 `retry_payment` 用于未完成更新. `refund` 用于完成离线更新,并返回生命周期摘要,包括付款信息外加回滚贷项或恢复到期.

## 续约付款关系

更新列表/详细计划现在显示链接 `payment` 已存在付款尝试时的IRI.

## 常见问题

### @deliverart/sdk-js-subscription 是什么？

为订阅管理交付JavaScript SDK

### 如何安装 @deliverart/sdk-js-subscription？

在项目目录运行 npm install @deliverart/sdk-js-subscription，或使用 pnpm add / yarn add / bun add。

### @deliverart/sdk-js-subscription 支持 TypeScript 吗？

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

### @deliverart/sdk-js-subscription 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @deliverart/sdk-js-subscription 可以商用吗？

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

### @deliverart/sdk-js-subscription 的下载量有多少？

根据 npm 官方下载统计，@deliverart/sdk-js-subscription 在 2026/10/12 – 2026/11/10 这 30 天内被下载 2,914 次，日均约 97 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @deliverart/sdk-js-subscription 还在维护吗？

最新版本 3\.0\.1 发布于 2026/11/11（1 天前）；至今共发布 125 个版本，其中过去 12 个月发布了 125 个；首次发布于 2026/03/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。