API Reference
API Reference

事件类型

事件名称事件类型触发时机通知数据结构描述
试用期即将到期通知subscription. trial_period_expiring试用期剩余时间小于 3 天时,提醒一次Subscription

用户订阅试用期 3 天后到期 。

使用场景:
  • 到期提醒:向用户推送到期提醒。
首次订阅通知subscription.first订阅首次生效时Subscription

订阅首次进入试用期或者活跃状态时通知,每个订阅只会发送一次。

使用场景:
  • 订阅成功推送:发送首次订阅成功的消息(如推送、邮件)
  • 权益发放:为用户解锁订阅对应的服务权限(如付费功能、资源额度)
终止订阅通知subscription.canceled订阅终止时Subscription

订阅实际终止时通知。

使用场景:
  • 终止服务提示:告知用户订阅已终止,明确服务停止时间
  • 权限回收:回收用户付费权益
订阅价格变更subscription.price_changed订阅价格变更时Subscription订阅价格变更时,通知变更具体信息。
账单支付成功invoice.paid一次性商品、首次订阅和订阅续订支付成功时通知Invoice

一次性商品和订阅相关的支付成功时会发送该通知。用于同步账单状态、订阅管理。

使用场景:
  • 账单状态同步:更新账单状态为"已完成";
  • 订阅管理:续订账单中会包含订阅周期信息,如当前周期数、周期时间等
账单支付失败invoice.payment_failed一次性商品、首次订阅和订阅续订支付失败时通知Invoice

一次性商品和订阅相关的支付失败时会发送该通知。不会每次重试支付失败都通知,只在最终支付失败时通知。

使用场景:
  • 失败提醒与引导支付:告知用户支付失败,提供重新支付入口
账单退款invoice.refunded当订阅产生的交易单退款成功时通知,用于获取订阅退款信息Invoice一次性商品和订阅相关的支付发生退款时会发送该事件。用于同步退款状态。
交易单支付成功trades.succeeded支付成功时Trade所有类型的支付成功时会发送该通知,适用于纯金额交易的闭环。
交易单支付失败trades.payment_failed支付失败时Trade所有类型的支付失败时会发送该通知,适用于纯金额交易的闭环。
退款成功refunds.succeeded退款成功时Refund

退款实际完成时通知。

使用场景:
  • 退款通知与状态同步:告知用户退款金额,更新退款单状态为"已完成"
退款失败refunds.failed退款失败时Refund

退款实际失败时通知

使用场景:
  • 状态同步:更新退款单状态为“失败"
  • 重试与人工干预:触发自动重试机制,或通知客服人工排查,及时重新发起退款,避免用户投诉和资金纠纷。


These developer docs retire on 2026-08-30. Visit the new docs: NEW DOCS本开发者文档将于 2026-08-30下线,请访问新版文档: 新文档