メインコンテンツへスキップ
有効または保留中のサブスクリプションをキャンセルします。動作は現在のサブスクリプションステータスによって異なります。 
POST /v1/actions/subscription-order/cancel-order
認証： API Key (owner role)

​
キャンセルの動作

現在のステータスアクション結果ステータス
pending即時キャンセルcanceled
active期間終了時にキャンセル（PSP 経由）canceling -> canceled at period end
  • 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) — Active Subscription

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

​
成功レスポンス (200) — Pending Subscription

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

​
レスポンスフィールド

フィールド型説明
orderIdstring注文 ID（Short ID）
statusstring新しい注文ステータス（canceling または canceled）

​
エラーレスポンス

ステータス説明
400orderId の欠落 / サブスクリプションが pending または active ステータスではありません
401認証失敗
403注文が現在のマーチャントに属していません（所有権チェック失敗）
404注文が見つかりません
502PSP エラー（決済プロバイダーが利用不可）