サブスクリプション商品を有効化または無効化します。
POST /v1/actions/subscription-product/update-status
認証: API Key
リクエストボディ
| フィールド | 型 | 必須 | 説明 |
|---|
id | string | Yes | 商品 ID(PROD_xxx フォーマット) |
status | string | Yes | active または inactive |
リクエスト例
import { ProductVersionStatus } from "@waffo/pancake-ts";
await client.subscriptionProducts.updateStatus({
id: "PROD_3F7H2J5L8N1Q4S6U",
status: ProductVersionStatus.Inactive,
});
成功レスポンス (200)
{
"data": {
"product": {
"id": "PROD_3F7H2J5L8N1Q4S6U",
"storeId": "STO_2D5F8G3H1K4M6N9P",
"name": "Pro Plan",
"description": "Full access to all Pro features.",
"billingPeriod": "monthly",
"prices": {
"USD": { "amount": "29.00", "taxCategory": "saas" },
"EUR": { "amount": "27.00", "taxCategory": "saas" }
},
"media": [],
"successUrl": "https://example.com/welcome",
"metadata": { "trialDays": 14 },
"status": "inactive",
"createdAt": "2026-03-30T10:30:00.000Z",
"updatedAt": "2026-03-30T13:00:00.000Z"
}
}
}
レスポンスフィールド
サブスクリプション商品の作成レスポンスと同じです。
サブスクリプション商品を無効化すると新規登録は防止されますが、既存のアクティブなサブスクリプションはキャンセルされません。加入者は現在の請求サイクルに影響なく継続します。
エラー
リトライポリシー:4xx は一切リトライしない — リクエストを修正してから再送信。5xx は指数バックオフでリトライ(5s 開始、最大 3 回)。
| ステータス | errors[0].message | 意味 | 推奨処理 |
|---|
| 400 | Missing header: x-context-merchant-id | マーチャントコンテキスト header が転送されていない | SDK 設定を修正 |
| 400 | Missing or invalid header: x-context-environment | 環境 header が欠落、または test / prod ではない | X-Environment を test または prod に設定 |
| 400 | Missing required field: id | リクエストボディに id が含まれない | id を追加して再送信 |
| 400 | Expected format: PROD_xxx, got "X" | id が正しい Short ID ではない | PROD_ 接頭辞付きの Short ID を使用 |
| 400 | Invalid or missing status (must be 'active' or 'inactive') | status 欠落または許可値以外 | active または inactive を使用 |
| 400 | メッセージに has no version を含む | 対象環境(test または prod)にバージョンがまだない | 先にこの環境でバージョンを作成(test から公開、または test で作成) |
| 401 | Unauthorized | 認証失敗 | API Key、タイムスタンプ、署名を確認 |
| 404 | Product not found / Current version not found | product ID が存在しない(または現行バージョン欠落) | product ID を確認 |
| 500 | Internal server error | 一時的な下流障害 | 指数バックオフでリトライ(5s 開始、最大 3 回) |