恢复 - Dodo Payments Documentation

遗弃的购物车恢复事件

以下 webhook 事件跟踪遗弃购物车恢复生命周期：

Event	Description
`abandoned_checkout.detected`	检测到遗弃的结账。当付款被识别为遗弃（失败或未完成）且恢复工作流程开始时发送。
`abandoned_checkout.recovered`	顾客通过恢复链接完成付款。`recovered_payment_id` 字段包含成功的付款 ID。

遗弃结账负载字段

string

必填

遗弃的原始付款。使用此功能查找产品、金额和货币详情。

string

必填

此 abandoned checkout 所属的品牌。

string

必填

放弃结账流程的客户。

string

必填

结账流程被放弃的原因。可能为以下值之一：

payment_failed — 客户尝试付款，但付款失败
checkout_incomplete — 客户访问了结账流程，但从未尝试付款

string

必填

此恢复尝试当前所处的生命周期状态。可能为以下值之一：

abandoned — 已检测到，但尚未发送任何电子邮件
recovering — 至少已发送一封恢复电子邮件
recovered — 客户已完成付款
exhausted — 所有电子邮件均已发送，或已找到更新的结账流程
opted_out — 客户已取消订阅

string

必填

检测到结账流程被放弃的时间，采用 ISO 8601 时间戳表示。

string | null

成功恢复付款的 payment ID。在结账流程恢复之前为 null。

示例：处理 ACR Webhook

app.post('/webhooks/dodo', async (req, res) => {
  const event = req.body;

  switch (event.type) {
    case 'abandoned_checkout.detected':
      console.log(`Checkout abandoned: ${event.data.payment_id}`);
      console.log(`Reason: ${event.data.abandonment_reason}`);
      // Track abandonment in your analytics
      await trackAbandonment(event.data);
      break;

    case 'abandoned_checkout.recovered':
      console.log(`Checkout recovered: ${event.data.payment_id}`);
      console.log(`Recovery payment: ${event.data.recovered_payment_id}`);
      // Grant access, update records
      await handleRecovery(event.data);
      break;
  }

  res.json({ received: true });
});

Dunning 事件

以下 Webhook 事件用于跟踪订阅的 Dunning 生命周期：

事件	描述
`dunning.started`	为进入 `on_hold` 状态或被客户取消的订阅创建了 Dunning 尝试。
`dunning.recovered`	客户更新了付款方式，随后付款成功。`payment_id` 字段包含成功付款的 ID。

Dunning 尝试负载字段

string

必填

触发此 Dunning 尝试的订阅。

string

必填

此 Dunning 尝试所属的品牌。

string

必填

拥有该订阅的客户。

string

必填

触发催收的订阅状态。以下之一：

on_hold — 因支付失败而停止续订
cancelled — 客户从客户门户取消

string

必填

此 Dunning 尝试当前所处的生命周期状态。可能为以下值之一：

recovering — 正在发送 Dunning 电子邮件
recovered — 客户已更新付款方式，且付款成功
exhausted — 所有电子邮件均已发送，或订阅状态已发生变化

string

必填

创建 Dunning 尝试的时间，采用 ISO 8601 时间戳表示。

string | null

成功恢复付款的 payment ID。在恢复过程中为 null。

示例：处理 Dunning Webhook

app.post('/webhooks/dodo', async (req, res) => {
  const event = req.body;

  switch (event.type) {
    case 'dunning.started':
      console.log(`Dunning started for subscription: ${event.data.subscription_id}`);
      console.log(`Trigger: ${event.data.trigger_state}`);
      // Track dunning in your system
      await trackDunning(event.data);
      break;

    case 'dunning.recovered':
      console.log(`Subscription recovered: ${event.data.subscription_id}`);
      console.log(`Recovery payment: ${event.data.payment_id}`);
      // Reactivate access, update records
      await handleDunningRecovery(event.data);
      break;
  }

  res.json({ received: true });
});

订阅 dunning.started 和 dunning.recovered，以跟踪完整的 Dunning 生命周期。在系统中，使用 dunning.started 暂停宽限期或标记有风险的订阅。

Abandoned Cart Recovery

配置 ACR 电子邮件序列和折扣激励措施。

Subscription Dunning

为已失效的订阅配置 Dunning 电子邮件序列。

Subscription Webhooks

相关的订阅生命周期事件，例如 subscription.on_hold 和 subscription.cancelled。

Webhook 负载架构

Webhook payload for abandoned_checkout.detected and abandoned_checkout.recovered events

abandoned_at

string<date-time>

必填

abandonment_reason

enum<string>

必填

可用选项:

payment_failed,

checkout_incomplete

brand_id

string

必填

Brand id this abandoned checkout belongs to

customer_id

string

必填

payment_id

string

必填

status

enum<string>

必填

可用选项:

abandoned,

recovering,

recovered,

exhausted,

opted_out

recovered_payment_id

string | null

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

恢复

遗弃的购物车恢复事件

遗弃结账负载字段

示例：处理 ACR Webhook

Dunning 事件

Dunning 尝试负载字段

示例：处理 Dunning Webhook

Abandoned Cart Recovery

Subscription Dunning

Subscription Webhooks

Webhook 负载架构

​遗弃的购物车恢复事件

​遗弃结账负载字段

​示例：处理 ACR Webhook

​Dunning 事件

​Dunning 尝试负载字段

​示例：处理 Dunning Webhook

Abandoned Cart Recovery

Subscription Dunning

Subscription Webhooks

​Webhook 负载架构

遗弃的购物车恢复事件

遗弃结账负载字段

示例：处理 ACR Webhook

Dunning 事件

Dunning 尝试负载字段

示例：处理 Dunning Webhook

Webhook 负载架构