@ 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

订阅计划目录

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

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

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

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

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。 。 。 .

管理计划分配

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

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 计划.

订阅

从公共计划中创建购买:

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',
  }),
)

开始购买付款 :

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

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

订阅帐单为平台级别:

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

解决离线支付 :

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 同意或拒绝它.

取消未完成的购买 :

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

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

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

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

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

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

退还已完成的离线采购:

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

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

更新支付开始

消费更新:

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

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

时间更新:

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

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

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

续约付款解决

消费更新:

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

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

时间更新:

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 在人工批准之前.

管理计费阅读模式

待核查队列 :

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

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

帐单概览计数器:

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

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

总体有效载荷暴露于:

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

寿命周期动作

消费更新:

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',
  }),
)

时间更新:

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.