跳转到主要内容
取消活跃或待处理的订阅。行为取决于当前订阅状态。 
POST /v1/actions/subscription-order/cancel-order
认证方式： API Key（owner 角色）

​
取消行为

当前状态操作结果状态
pending立即取消canceled
active在周期结束时取消（通过 PSP）canceling -> 周期结束时变为 canceled
  • pending：直接取消，状态变为 canceled
  • active：触发 PSP 取消（在计费周期结束时生效）。本地状态变为 canceling，然后在周期结束时通过 Webhook 更新为 canceled

​
请求体

字段类型必需说明
orderIdstring是订阅订单 ID（Short ID 格式 ORD_xxx）

​
请求示例

import { WaffoPancake } from "@waffo/pancake-ts";

const client = new WaffoPancake({
  merchantId: process.env.WAFFO_MERCHANT_ID!,
  privateKey: process.env.WAFFO_PRIVATE_KEY!,
});

const result = await client.orders.cancelSubscription({
  orderId: "ORD_2aUyqjCzEIiEcYMKj7TZtw",
});

console.log(result.orderId); // "ORD_2aUyqjCzEIiEcYMKj7TZtw"
console.log(result.status);  // "canceling" or "canceled"

​
成功响应 (200) — 活跃订阅

{
  "data": {
    "orderId": "ORD_2aUyqjCzEIiEcYMKj7TZtw",
    "status": "canceling"
  }
}

​
成功响应 (200) — 待处理订阅

{
  "data": {
    "orderId": "ORD_2aUyqjCzEIiEcYMKj7TZtw",
    "status": "canceled"
  }
}

​
响应字段

字段类型说明
orderIdstring订单 ID（Short ID）
statusstring新的订单状态（canceling 或 canceled）

​
错误响应

状态码说明
400缺少 orderId / 订阅不处于 pending 或 active 状态
401认证失败
403订单不属于当前商户（所有权检查失败）
404订单未找到
502PSP 错误（支付服务提供商不可用）