商品グループの名前、説明、ルール、または商品リストを更新します。
POST /v1/actions/subscription-product-group/update-group
認証: API Key
リクエストボディ
| フィールド | 型 | 必須 | 説明 |
|---|
id | string | Yes | グループ ID(UUID フォーマット) |
name | string | No | 更新後のグループ名 |
description | string | No | 更新後の説明 |
rules | object | No | 更新後のルール({ sharedTrial: boolean }) |
productIds | string[] | No | 更新後の商品リスト(PROD_xxx フォーマット)。リスト全体を置換します。 |
リクエスト例
const { group } = await client.subscriptionProductGroups.update({
id: "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f9a",
name: "Updated Pricing Plans",
productIds: [
"PROD_3F7H2J5L8N1Q4S6U",
"PROD_8B4D6F9H2K5M7P1R",
],
});
productIds フィールドは商品リスト全体を置換します。商品を追加するには、既存の商品 ID すべてと新しい ID を含めてください。商品を削除するには、リストから省略してください。
エラー
リトライポリシー:4xx は一切リトライしない — リクエストを修正してから再送信。5xx は指数バックオフでリトライ(5s 開始、最大 3 回)。
| ステータス | errors[0].message | 意味 | 推奨処理 |
|---|
| 400 | Missing required field: id | リクエストボディに id が含まれない | id を追加して再送信 |
| 400 | Expected format: PROD_xxx, got "..." | productIds の Short ID をデコードできない | ID を修正して再送信 |
| 404 | Group not found | 指定された id のグループが存在しない | id が自分のストアに属しているか確認 |
| 500 | Internal server error | 内部エラーまたは一時的な下流障害 | 指数バックオフでリトライ(5s 開始、最大 3 回) |