メインコンテンツへスキップ
商品グループの名前、説明、ルール、または商品リストを更新します。
POST /v1/actions/subscription-product-group/update-group
認証: API Key

リクエストボディ

フィールド必須説明
idstringYesグループ ID(UUID フォーマット)
namestringNo更新後のグループ名
descriptionstringNo更新後の説明
rulesobjectNo更新後のルール({ sharedTrial: boolean }
productIdsstring[]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意味推奨処理
400Missing required field: idリクエストボディに id が含まれないid を追加して再送信
400Expected format: PROD_xxx, got "..."productIds の Short ID をデコードできないID を修正して再送信
404Group not found指定された id のグループが存在しないid が自分のストアに属しているか確認
500Internal server error内部エラーまたは一時的な下流障害指数バックオフでリトライ(5s 開始、最大 3 回)