メインコンテンツへスキップ
サブスクリプション商品を有効化または無効化します。
POST /v1/actions/subscription-product/update-status
認証: API Key

リクエストボディ

フィールド必須説明
idstringはい商品 ID(PROD_xxx 形式)
statusstringはいactive または inactive

リクエスト例

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

await client.subscriptionProducts.updateStatus({
  id: "PROD_3F7H2J5L8N1Q4S6U",
  status: ProductVersionStatus.Inactive,
});
サブスクリプション商品を無効化すると新規サインアップは防止されますが、既存の有効なサブスクリプションはキャンセルされません。サブスクライバーは現在の請求サイクルを影響なく継続します。

エラーレスポンス

ステータス条件
400無効な status 値(active または inactive でなければなりません)
400商品に既存のバージョンがありません
404商品が見つかりません