POST /v1/actions/subscription-order/cancel-order
このエンドポイントには customer 側の session-token フローもあります：サブスクリプションのキャンセル（Customer） を参照。
キャンセル動作
| 現在のステータス | アクション | 結果ステータス |
|---|---|---|
pending | 即時キャンセル | canceled |
active | 期間終了時にキャンセル（PSP 経由） | canceling -> 期間終了時に canceled |
- pending: 直接キャンセルされ、ステータスは
canceledになります - active: PSP キャンセルがトリガーされます（請求期間の終了時に有効）。ローカルステータスは
cancelingになり、期間終了時に Webhook 経由でcanceledに更新されます
リクエストボディ
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
orderId | string | Yes | サブスクリプション注文 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"
// Assumes callApi() is defined as shown in the Authentication guide
const result = await callApi("POST", "/v1/actions/subscription-order/cancel-order", {
orderId: "ORD_2aUyqjCzEIiEcYMKj7TZtw",
});
// Assumes callApi() is defined as shown in the Authentication guide
String result = callApi("POST", "/v1/actions/subscription-order/cancel-order",
"{\"orderId\":\"ORD_2aUyqjCzEIiEcYMKj7TZtw\"}");
# Assumes call_api() is defined as shown in the Authentication guide
result = call_api("POST", "/v1/actions/subscription-order/cancel-order", {
"orderId": "ORD_2aUyqjCzEIiEcYMKj7TZtw",
})
// Assumes callAPI() is defined as shown in the Authentication guide
result, err := callAPI("POST", "/v1/actions/subscription-order/cancel-order",
`{"orderId":"ORD_2aUyqjCzEIiEcYMKj7TZtw"}`)
// Assumes call_api() is defined as shown in the Authentication guide
let result = call_api("POST", "/v1/actions/subscription-order/cancel-order",
r#"{"orderId":"ORD_2aUyqjCzEIiEcYMKj7TZtw"}"#
).await?;
// Assumes call_api() is defined as shown in the Authentication guide
call_api("/v1/actions/subscription-order/cancel-order",
"{\"orderId\":\"ORD_2aUyqjCzEIiEcYMKj7TZtw\"}");
// Assumes call_api() is defined as shown in the Authentication guide
auto result = call_api("/v1/actions/subscription-order/cancel-order",
R"({"orderId":"ORD_2aUyqjCzEIiEcYMKj7TZtw"})");
MERCHANT_ID="MER_2aUyqjCzEIiEcYMKj7TZtw"
TIMESTAMP=$(date +%s)
BODY='{"orderId":"ORD_2aUyqjCzEIiEcYMKj7TZtw"}'
BODY_HASH=$(echo -n "$BODY" | openssl dgst -sha256 -binary | base64 | tr -d '\n')
CANONICAL="POST
/v1/actions/subscription-order/cancel-order
$TIMESTAMP
$BODY_HASH"
SIGNATURE=$(echo -n "$CANONICAL" | openssl dgst -sha256 -sign private_key.pem | base64 | tr -d '\n')
curl -X POST "https://api.waffo.ai/v1/actions/subscription-order/cancel-order" \
-H "Content-Type: application/json" \
-H "X-Merchant-Id: $MERCHANT_ID" \
-H "X-Timestamp: $TIMESTAMP" \
-H "X-Signature: $SIGNATURE" \
-d "$BODY"
MERCHANT_ID="MER_2aUyqjCzEIiEcYMKj7TZtw"
TIMESTAMP=$(date +%s)
BODY='{"orderId":"ORD_2aUyqjCzEIiEcYMKj7TZtw"}'
BODY_HASH=$(echo -n "$BODY" | openssl dgst -sha256 -binary | base64 | tr -d '\n')
CANONICAL="POST
/v1/actions/subscription-order/cancel-order
$TIMESTAMP
$BODY_HASH"
SIGNATURE=$(echo -n "$CANONICAL" | openssl dgst -sha256 -sign private_key.pem | base64 | tr -d '\n')
wget -qO- --post-data="$BODY" \
--header="Content-Type: application/json" \
--header="X-Merchant-Id: $MERCHANT_ID" \
--header="X-Timestamp: $TIMESTAMP" \
--header="X-Signature: $SIGNATURE" \
"https://api.waffo.ai/v1/actions/subscription-order/cancel-order"
成功レスポンス (200) — 有効なサブスクリプション
{
"data": {
"orderId": "ORD_2aUyqjCzEIiEcYMKj7TZtw",
"status": "canceling"
}
}
成功レスポンス (200) — 保留中のサブスクリプション
{
"data": {
"orderId": "ORD_2aUyqjCzEIiEcYMKj7TZtw",
"status": "canceled"
}
}
レスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
orderId | string | 注文 ID（Short ID） |
status | string | 新しい注文ステータス（canceling または canceled） |
エラー
リトライポリシー：4xx は一切リトライしない — リクエストを修正してから再送信。5xx は指数バックオフでリトライ（5s 開始、最大 3 回）。
| ステータス | errors[0].message | 意味 | 推奨処理 |
|---|---|---|---|
| 400 | Missing X-Context-Merchant-Id header | API Key 認証下で merchant コンテキストが欠落 | 認証パイプラインを確認 |
| 400 | Missing required field: orderId | リクエストボディに orderId が含まれていない | リクエストボディを修正してから再送信 |
| 400 | Expected format: ORD_xxx, got "..." | orderId Short ID のデコード失敗 | orderId のフォーマットを修正してから再送信 |
| 400 | Subscription cannot be canceled, current status: X | 注文ステータスが pending または active ではない（canceled、canceling、expired など） | サブスクリプションはキャンセル不可 |
| 401 | Authentication failed | API Key 署名が無効 | 認証ヘッダーを確認 |
| 403 | Order does not belong to user | 所有権チェック失敗 | 呼び出し元が注文を所有しているか確認 |
| 404 | Order not found | 注文が存在しない | order ID を確認 |
| 500 | Internal server error | サーバ側の予期しない障害 | 指数バックオフでリトライ（5s 開始、最大 3 回） |
| 502 | Failed to cancel subscription | ローカル更新または PSP キャンセル失敗 | 指数バックオフでリトライ（5s 開始、最大 3 回） |