製品コレクション

Product Collections は関連製品（例：Starter、Pro、Enterprise プラン）をひとまとめにグループ化できます。すべてのオプションを単一のチェックアウトで表示し、アップグレード/ダウングレード経路を定義し、顧客がカスタマーポータルから直接プランを切り替えられる柔軟性を提供します。

複数の製品が表示されている製品コレクションのチェックアウトページのスクリーンショット

主なハイライト

コレクションベースの構造: 関連する製品（プラン、ティア、価格オプション）を単一のコレクションにグループ化して、管理を整理します。
1つのコレクション、複数の製品: スターター、プロ、ライフタイムなど、独自の価格モデルを持つ複数の製品を含めることができます。
ダイナミックなチェックアウト体験: 収集された製品を1つのチェックアウトビューで表示し、顧客が希望のプランを選択できます。
マーチャントレベルの制御: 各コレクション内で製品を有効化、無効化、および順序を変更できます。最初の製品はチェックアウト時に自動的に事前選択されます。
ライフサイクル認識: 顧客がCustomer Portalを介して同じコレクション内の製品をアップグレードまたはダウングレードできるようにします。

製品コレクションの作成

製品コレクションは、ダッシュボードまたはAPIを介して作成および管理されます。各コレクションは、関連する製品のコンテナとして機能します。

Create the collection

コレクションには名前と任意の説明を付けて定義します。チェックアウトでコレクションを視覚的に表現する画像をアップロードします。

名前、説明、画像アップロードのフィールドが表示されているダッシュボードの製品コレクション作成フォームのスクリーンショット

コレクションフィールド:

名前 (必須): コレクションの表示名（例：“SaaSプラン”、“ライセンスティア”）
説明 (任意): チェックアウトで表示される簡単な説明
画像 (任意): コレクションの視覚的ブランディング

Add products to the collection

既存の製品をコレクションに追加します。製品は構成を整えるためにグループ化できます。

製品のリストとそれらをコレクションに追加する機能が表示されている製品コレクション製品ページのスクリーンショット

製品の整理:

グループ: 製品を名前付きグループにオプションで整理（例：“月間プラン”、“年間プラン”）
無グループ製品: グループに属さない製品はコレクションレベルに表示されます
順序設定: ドラッグ＆ドロップで表示順を設定

各製品は 1 つのコレクションにのみ属することができます。すでに別のコレクションに含まれている製品は、先にそのコレクションから削除する必要があります。

Configure ordering and visibility

コレクション内の製品の表示順と表示/非表示を制御します。設定オプション:

製品の状態: コレクション内の各製品を有効または無効にする
表示順序: ドラッグ＆ドロップで製品がチェックアウトに表示される順序を設定

コレクション内の最初の製品がチェックアウト時のデフォルトとして自動的に事前選択されます。デフォルトで選択される製品を変更するには、製品の並び順を変更してください。

コレクションチェックアウト

コレクションは、顧客が1つの場所で利用可能なすべての製品を表示して選択できる統一されたチェックアウト体験を提供します。

チェックアウトタイプ

タイプ	説明	ユースケース
コレクションチェックアウト	コレクション内のすべてのアクティブな製品を表示	サブスクリプションプランの選択、ティアードプライシング
単一製品チェックアウト	特定の1つの製品のみを表示	直接購入、プロモーションリンク

コレクションチェックアウト体験

コレクションチェックアウトを使用する際：

すべてのアクティブな製品が表示される: 顧客はコレクション内のすべての有効な製品を見ることができます
最初の製品が事前選択される: コレクション順の最初の製品が自動的に選択されます
製品の詳細が表示される: 各製品はその名前、説明、および価格を表示します
単一選択: 顧客は購入する製品を1つ選択します
標準フローが続く: 選択後、チェックアウトは選択された製品の価格および請求設定に従って進行します

Collection checkout は、顧客が購入前にプランを並べて比較できるようにしたいサブスクリプションビジネスに最適です。

API統合

コレクションのためのチェックアウトセッションを作成します：

const session = await client.checkoutSessions.create({
  product_collection_id: 'pdc_abc123',
  product_cart: [], // Required: pass an empty array for collection checkout
  return_url: 'https://yoursite.com/return'
});

// Redirect customer to the checkout
window.location.href = session.checkout_url;

product_collection_id を使用する場合、セッション作成時に割引コードを適用できません。チェックアウト時に割引コードの入力を許可していれば、顧客は引き続き入力できます。

Customer Portal統合

顧客は同じコレクション内で製品をアップグレードまたはダウングレードできます。

既にサブスクリプション製品をお持ちですか？ 単にそれらを Product Collection に追加するだけで、カスタマーポータルでのアップグレード/ダウングレードフローを有効にできます。製品を再作成する必要はありません。

プラン管理アクション

アクション	説明	Merchant Control
現在のプランを表示	現在の商品名、価格、更新日を表示	常に利用可能
プランをアップグレード	同じコレクション内の上位ティアの商品に移行	設定可能（デフォルト：無効）
プランをダウングレード	同じコレクション内の下位ティアの商品に移行	設定可能（デフォルト：無効）
キャンセル	サブスクリプションを完全にキャンセル	常に利用可能

プラン管理の操作が表示されている製品コレクションのカスタマーポータルプラン変更インターフェースのスクリーンショット

アップグレード/ダウングレードルール

アップグレードとダウングレードは同じコレクション内の製品間でのみ利用可能です
プロレーションはサブスクリプション設定に基づいて適用されます
アップグレード、ダウングレード、キャンセルのたびにビジネスにメール通知が送信されます

顧客は現在のコレクション外の製品に変更することはできません。異なる製品ラインごとに別のコレクションを作成してください。

サブスクリプション設定

ダッシュボードの設定 → 定期購入から、ビジネス全体での定期購入とプラン変更の動作を設定します。

複数の定期購入を許可し、定期購入の更新を許可するトグルが表示されている定期購入設定ページのスクリーンショット

利用可能な設定

設定	説明	デフォルト
複数のサブスクリプションを許可	顧客が同時に複数のアクティブなサブスクリプションを保有できる	有効
サブスクリプションの更新を許可	顧客がCustomer Portalを通じて、既存のサブスクリプションをいつでもアップグレードまたはダウングレードできる	無効
サブスクリプションのキャンセルを許可	顧客がCustomer Portalから自身のサブスクリプションをキャンセルできる	有効
サブスクリプションの一時停止を許可	顧客がCustomer Portalから自身のサブスクリプションを一時停止および再開できる	無効
一時停止時に使用量を請求	使用量ベースのサブスクリプションを一時停止した時点で、未請求の使用量を請求書に含める。次回の通常の請求書まで使用量を繰り越さない	有効
トライアルの不正利用を防止	すでにトライアルを利用した顧客を、新たなトライアルを付与せず、有料・トライアルなしの購入に変更する	無効

カスタマーポータルを通じたプラン変更はデフォルトで無効になっています。同じコレクション内の製品間でアップグレードまたはダウングレードできるようにするには、設定 → 定期購入で「定期購入の更新を許可」を有効にしてください。

「サブスクリプションのキャンセルを許可」を無効にすると、顧客向けのセルフサービスによるキャンセルが非表示になり、Customer Portal API経由で行われたキャンセルリクエストが拒否されます。マーチャント側で行うキャンセルには影響しません。サブスクリプションのキャンセルを参照してください。

「Allow Subscription Pause」はCustomer Portalのみに適用されます。設定にかかわらず、ダッシュボードまたはAPIから一時停止および再開できます。「Bill Usage at Pause」は使用量ベースのサブスクリプションにのみ適用され、請求サイクルごとに記録されます。そのため、サイクルの途中で設定を変更しても、進行中のサイクルの精算方法は変わりません。サブスクリプションの一時停止と再開を参照してください。

トライアルの利用がどのように照合・記録されるかについては、トライアルの不正利用を防止を参照してください。

Subscription Plan Changes

日割り計算モードとプラン変更の動作について詳しく説明します。

コレクションの管理

Product Collectionsは、Dodo PaymentsダッシュボードまたはAPIを介してプログラムで管理できます。APIでは、コレクションの作成、更新、画像のアップロード、アーカイブ、ネストされたグループや商品の管理を完全に制御できます。

ダッシュボード操作

作成: 商品とグループを含む新しいコレクションを設定
更新: 名前、説明、画像、商品の構成を変更
並べ替え: ドラッグ＆ドロップで商品の表示順を変更
商品の有効化／無効化: チェックアウトに表示する商品を制御
アーカイブ: コレクションを完全に削除せず非表示にする（後でアーカイブ解除可能）

コレクション管理操作を示すProduct Collectionダッシュボードのスクリーンショット

API管理

次のエンドポイントを使用すると、Product Collectionsをプログラムで作成、更新、取得、アーカイブ、整理できます。ネストされたグループと、その中の商品も管理できます。

Listing Product Collections

GETリクエストを/product-collectionsエンドポイントに送信して、アカウントに関連付けられたすべてのProduct Collectionsを取得します。ページネーション、ブランドによるフィルタリング、アーカイブ済みコレクションの取得に対応しています。

List Product Collections API

詳細なリクエストおよびレスポンスの構造については、List Product Collections APIのドキュメントを参照してください。

Creating a Product Collection

名前、説明、ブランドなどの詳細を含むリクエストをPOSTエンドポイントに送信して、新しいProduct Collectionを作成します。

Create Product Collection API

詳細なリクエストおよびレスポンスの構造については、Create Product Collection APIのドキュメントを参照してください。

Retrieving a Product Collection

GETリクエストを/product-collections/{id}エンドポイントに送信して、特定のProduct Collectionに関する詳細情報（グループと商品アイテムを含む）を取得します。

Get Product Collection API

詳細なリクエストおよびレスポンスの構造については、Get Product Collection APIのドキュメントを参照してください。

Updating a Product Collection

PATCHリクエストを/product-collections/{id}エンドポイントに送信して、Product Collectionの詳細（名前、説明、ブランドなど）を変更します。

Update Product Collection API

詳細なリクエストおよびレスポンスの構造については、Update Product Collection APIのドキュメントを参照してください。

Uploading Collection Images

署名付きURLを使用して画像をアップロードし、コレクションに関連付けます。/product-collections/{id}/imagesエンドポイントからアップロードURLをリクエストし、返されたURLに60秒以内に画像をPUTします。

署名付きURLは60秒で期限切れになるため、その時間内に画像をアップロードする必要があります。

Update Collection Images API

詳細なリクエストおよびレスポンスの構造については、Update Collection Images APIのドキュメントを参照してください。

Archiving a Product Collection

DELETEリクエストを/product-collections/{id}エンドポイントに送信して、コレクションをアーカイブします。これにより新たな利用からコレクションが非表示になりますが、完全に削除されるわけではありません。

Archive Product Collection API

詳細なリクエストおよびレスポンスの構造については、Archive Product Collection APIのドキュメントを参照してください。

Unarchiving a Product Collection

POSTリクエストを/product-collections/{id}/unarchiveエンドポイントに送信して、アーカイブ済みのコレクションを復元します。

Unarchive Product Collection API

詳細なリクエストおよびレスポンスの構造については、Unarchive Product Collection APIのドキュメントを参照してください。

Managing Groups within a Collection

グループを使用すると、コレクション内の商品を整理できます（例：「月額プラン」と「年額プラン」）。グループのエンドポイントを使用して、コレクション内のグループを追加、更新、削除します。

グループを作成: POST /product-collections/{id}/groups
グループを更新: PATCH /product-collections/{id}/groups/{group_id}
グループを削除: DELETE /product-collections/{id}/groups/{group_id}

Create Group

Product Collectionに新しいグループを追加します。

Update Group

グループの名前または属性を変更します。

Delete Group

コレクションからグループを削除します。

Managing Products within a Group

グループ内の個々の商品アイテムを管理します。新しい商品の追加、既存のアイテム（表示順など）の更新、または完全な削除が可能です。

グループに商品を追加: POST /product-collections/{id}/groups/{group_id}/items
グループアイテムを更新: PATCH /product-collections/{id}/groups/{group_id}/items/{item_id}
グループアイテムを削除: DELETE /product-collections/{id}/groups/{group_id}/items/{item_id}

Add Products to Group

コレクション内のグループに1つ以上の商品を追加します。

Update Group Item

グループ内の商品アイテムを更新します。

Delete Group Item

グループから商品アイテムを削除します。

ベストプラクティス

論理的にグループ化する: 請求間隔（月額／年額）または機能ティア（starter／pro／enterprise）ごとに商品を整理する
戦略的に並べる: 最も人気のあるプランまたは推奨プランを先頭に配置する。チェックアウト時にあらかじめ選択されます
わかりやすい名前を使用する: 商品名で価値の違いを明確に伝える
両方向を有効にする: 顧客に柔軟性を提供するため、アップグレードとダウングレードの両方を許可する
日割り計算を検討する: ビジネスモデルに合った日割り計算モードを選択する
十分にテストする: 本番稼働前に、テストモードでチェックアウトとプラン変更のフローを確認する

Product Collectionsを作成し、顧客に統一されたプラン選択エクスペリエンスを提供する準備が整いました。

Products

コレクションに追加する単発、サブスクリプション、または使用量ベースの商品を作成します。

Checkout

統一されたチェックアウトエクスペリエンスでコレクションの商品を表示します。

Customer Portal

顧客が同じコレクション内でアップグレードまたはダウングレードできるようにします。

Subscriptions

日割り計算とプラン変更を使用して、継続プランを管理します。

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

主なハイライト

製品コレクションの作成