サブスクリプション商品を有効化または無効化します。
POST /v1/actions/subscription-product/update-status
認証: API Key
リクエストボディ
| フィールド | 型 | 必須 | 説明 |
|---|
id | string | はい | 商品 ID(PROD_xxx 形式) |
status | string | はい | active または inactive |
リクエスト例
import { ProductVersionStatus } from "@waffo/pancake-ts";
await client.subscriptionProducts.updateStatus({
id: "PROD_3F7H2J5L8N1Q4S6U",
status: ProductVersionStatus.Inactive,
});
サブスクリプション商品を無効化すると新規サインアップは防止されますが、既存の有効なサブスクリプションはキャンセルされません。サブスクライバーは現在の請求サイクルを影響なく継続します。
エラーレスポンス
| ステータス | 条件 |
|---|
400 | 無効な status 値(active または inactive でなければなりません) |
400 | 商品に既存のバージョンがありません |
404 | 商品が見つかりません |