メインコンテンツへスキップ
サブスクリプション商品は、設定可能な請求サイクルとマルチ通貨価格設定による定期課金をサポートしています。商品はグループに整理して、共有トライアル管理や階層型価格プランを実現できます。

請求サイクル

期間頻度
weekly7日ごと
monthly毎月
quarterly3か月ごと
yearly12か月ごと

グループオブジェクト

商品グループは関連するサブスクリプション商品(例:Free、Pro、Enterprise プラン)を整理し、グループ内の商品間で共有トライアル管理を可能にします。各グループは環境ごとに存在し、テスト用と本番用に1つずつあります。
{
  "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"
}
グループ ID は UUID 形式であり、Short ID 形式ではありません。これは API で生の UUID を使用する唯一のエンティティです。
フィールド説明
idstringGroup ID (UUID format)
storeIdstringStore ID (STO_xxx format)
namestringGroup name (unique per store + environment)
descriptionstring | nullGroup description
rulesobjectGroup rules (see below)
productIdsstring[]List of product IDs (PROD_xxx format)
environmentstringtest or prod
createdAtstringISO 8601 timestamp
updatedAtstringISO 8601 timestamp

ルール

フィールドデフォルト説明
sharedTrialbooleanfalseWhen true, trial usage is shared across all products in the group. Prevents customers from signing up for repeated free trials by switching between products in the same group.

エンドポイント

商品の作成

請求サイクルとマルチ通貨対応のサブスクリプション商品を作成します。

商品の更新

サブスクリプション商品のコンテンツを更新します。コンテンツが変更された場合、新しいイミュータブルバージョンが作成されます。

商品の公開

サブスクリプション商品をテストから本番に公開します(初回公開のみ)。

ステータスの更新

サブスクリプション商品を有効化または無効化します。

グループの作成

関連するサブスクリプション商品を整理するための商品グループを作成します。

グループの更新

商品グループの名前、説明、ルール、または商品リストを更新します。

グループの削除

商品グループを完全に削除します。

グループの公開

テストから本番に商品グループを公開します(繰り返しの UPSERT をサポート)。