メインコンテンツへスキップ
関連するサブスクリプション商品を整理するための商品グループを作成します。
POST /v1/actions/subscription-product-group/create-group
認証: API Key

リクエストボディ

フィールド必須説明
storeIdstringYesStore ID(STO_xxx フォーマット)
namestringYesグループ名(ストア + 環境ごとに一意)
descriptionstringNoグループの説明
rulesobjectNoグループルール({ sharedTrial: boolean }
productIdsstring[]No含めるサブスクリプション商品 ID(PROD_xxx フォーマット)

リクエスト例

const { group } = await client.subscriptionProductGroups.create({
  storeId: "STO_2D5F8G3H1K4M6N9P",
  name: "Pricing Plans",
  description: "Free, Pro, and Enterprise tiers",
  rules: { sharedTrial: true },
  productIds: [
    "PROD_3F7H2J5L8N1Q4S6U",
    "PROD_8B4D6F9H2K5M7P1R",
    "PROD_1C3E5G7J0L2N4Q6S",
  ],
});

成功レスポンス (200)

{
  "data": {
    "group": {
      "id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f9a",
      "storeId": "STO_2D5F8G3H1K4M6N9P",
      "name": "Pricing Plans",
      "description": "Free, Pro, and Enterprise tiers",
      "rules": { "sharedTrial": true },
      "productIds": [
        "PROD_3F7H2J5L8N1Q4S6U",
        "PROD_8B4D6F9H2K5M7P1R",
        "PROD_1C3E5G7J0L2N4Q6S"
      ],
      "environment": "test",
      "createdAt": "2026-03-30T10:30:00.000Z",
      "updatedAt": "2026-03-30T10:30:00.000Z"
    }
  }
}

エラー

リトライポリシー:4xx は一切リトライしない — リクエストを修正してから再送信。5xx は指数バックオフでリトライ(5s 開始、最大 3 回)。
ステータスerrors[0].message意味推奨処理
400Missing or invalid header: x-context-environmentenvironment ヘッダーが欠落、または test / prod 以外ヘッダーを修正して再送信
400Missing required fields: storeId, name必須フィールド欠落フィールドを追加して再送信
400Expected format: STO_xxx, got "..." / Expected format: PROD_xxx, got "..."storeId または productIds の Short ID をデコードできないID を修正して再送信
500Internal server error内部エラーまたは一時的な下流障害指数バックオフでリトライ(5s 開始、最大 3 回)