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

​
請求サイクル

​
グループオブジェクト

商品グループは関連するサブスクリプション商品（例：Free、Pro、Enterprise プラン）を整理し、グループ内の商品間で共有トライアル管理を可能にし、顧客がどのプラン間で切り替えられるかの範囲を定めます。各グループは環境ごとに存在し、テスト用と本番用に1つずつあります。
グループ ID は UUID 形式であり、Short ID 形式ではありません。これは API で生の UUID を使用する唯一のエンティティです。

​
ルール

rules の各キーは独立したスイッチで、いずれも既定は false です。
両方のスイッチは明示的に有効化しない限り無効です —— 既に存在するグループも同様です。 グループの保存済みルールに存在しないキーは false として読み出されるため、そのスイッチが登場する前に作成されたグループはすべて無効の状態です。顧客のセルフサービスのプラン変更が機能しない場合は、まずそのグループの selfServicePlanChange を確認してください。
update-group は rules をフィールド単位でマージし、オブジェクトを置き換えません。 rules: { selfServicePlanChange: true } を送っても sharedTrial は保存済みの値のまま維持されるため、変更しないスイッチを再送する必要はありません。これは全体を置き換える productIds とは逆の挙動です。認識できないキーは保存されずに破棄され、rules: null はフィールドを省略した場合と同じ扱いになります。

​
エンドポイント

商品の作成

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

商品の更新

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

商品の公開

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

ステータスの更新

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

グループの作成

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

グループの更新

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

グループの削除

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

グループの公開

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