製品コレクション

Product Collections は、関連する商品（Starter、Pro、Enterprise プランなど）を1つのまとまりにグループ化します。すべてのオプションを1つのチェックアウトに表示し、アップグレード／ダウングレードのフローを定義して、顧客が Customer Portal から直接プランを変更できるようにします。

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

主なハイライト

Product Collections では、次のことができます。

関連する商品（プラン、ティア、料金オプション）をまとめて、整理して管理する。
Starter、Pro、Lifetime など、独自の料金モデルを持つ複数の商品を含める。
すべての商品を1つのチェックアウト画面に表示し、顧客が比較して希望するプランを選択できるようにする。
Customer Portal を通じて、同じコレクション内の商品間で顧客がアップグレードまたはダウングレードできるようにする。
表示する商品、表示順、チェックアウト時にあらかじめ選択する商品を制御する。

Product Collection の作成

ダッシュボードまたは API からコレクションを作成・管理します。

Create the collection

名前と任意の説明を指定してコレクションを定義します。チェックアウトで表示する画像をアップロードできます。

ダッシュボードの Product Collection 作成フォームのスクリーンショット。名前、説明、画像アップロードのフィールドが表示されています

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

Name（必須）: 表示名（例: “SaaS Plans”, “License Tiers”）。
Description（任意）: チェックアウトに表示される簡単な説明。
Image（任意）: コレクションのビジュアルブランディング。

Add products to the collection

既存の商品をコレクションに追加します。より適切に構成できるよう、商品をグループに整理します。

Product Collection の商品ページのスクリーンショット。商品の一覧と、コレクションに追加する機能が表示されています

商品の整理:

Groups: 商品を名前付きグループ（例: “Monthly Plans”, “Annual Plans”）に任意で整理します。
Ungrouped products: グループに属さない商品はコレクションレベルに表示されます。
Ordering: ドラッグ＆ドロップで表示順を設定します。

各商品は1つのコレクションにのみ所属できます。商品がすでに別のコレクションに含まれている場合は、先にそこから削除してください。

Configure ordering and visibility

コレクション内の商品の表示順と表示状態を管理します。設定オプション:

Product status: コレクション内の個々の商品を有効または無効にします。
Display order: ドラッグ＆ドロップで、チェックアウトに表示される商品の順序を設定します。

コレクション内で最初の商品が、チェックアウト時に自動的にあらかじめ選択されます。商品の順序を変更すると、デフォルトで選択される商品を変更できます。

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

コレクションを使用すると、顧客が1か所ですべての利用可能な商品を確認して選択できる、統一されたチェックアウト体験を提供できます。

チェックアウトの種類

種類	説明	用途
Collection Checkout	コレクション内のすべての有効な商品を表示します	サブスクリプションプランの選択、段階的な料金設定
Single Product Checkout	特定の1つの商品だけを表示します	直接購入、プロモーションリンク

Collection Checkout の体験

コレクションチェックアウトを使用すると、次のようになります。

コレクション内のすべての有効な商品が表示されます。
コレクション内の順序で最初の商品が自動的にあらかじめ選択されます。
各商品に名前、説明、料金が表示されます。
顧客が購入する商品を1つ選択します。
選択した商品の料金と請求設定でチェックアウトが進行します。

Product Collection のチェックアウトページのスクリーンショット。複数の商品が表示されています

コレクションチェックアウトは、購入前に顧客がプランを並べて比較するサブスクリプションビジネスに適しています。

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'
});

window.location.href = session.checkout_url;

product_collection_id を使用する場合、セッション作成時に割引コードを事前適用することはできません。ただし、有効になっていれば、顧客はチェックアウト中にコードを入力できます。

Customer Portal の統合

顧客は Customer Portal から直接、同じコレクション内の商品間でアップグレードまたはダウングレードできます。

すでにサブスクリプション商品がある場合は、それらを Product Collection に追加して、Customer Portal でアップグレード／ダウングレードのフローを有効にします。商品を作り直す必要はありません。

プラン管理の操作

操作	説明	Merchant の制御
View Current Plan	現在の商品名、料金、更新日を表示します。	常に利用可能。
Upgrade Plan	同じコレクション内の上位ティアの商品に移行します。	設定可能（デフォルト: 無効）。
Downgrade Plan	同じコレクション内の下位ティアの商品に移行します。	設定可能（デフォルト: 無効）。
Cancel	サブスクリプションを完全にキャンセルします。	常に利用可能。

アップグレード／ダウングレードのルール

アップグレードとダウングレードは、同じコレクション内の商品間でのみ利用できます。
Customer Portal のプラン変更に対する日割り計算は、Settings → Subscriptions のデフォルトのアップグレードおよびダウングレード動作に従います。各コレクションでは、これらのデフォルトを上書きできます。Change Plan API を通じて行うプラン変更では、リクエストとともに送信された proration_billing_mode が使用されます。
アップグレード、ダウングレード、またはキャンセルのたびに、ビジネスにメール通知が送信されます。

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

サブスクリプション設定

ダッシュボードの Settings → Subscriptions から、ビジネス全体でのサブスクリプションとプラン変更の動作を設定します。

利用可能な設定

設定	説明	デフォルト
Allow Multiple Subscriptions	顧客が同時に複数の有効なサブスクリプションを保持できるようにします。	有効
Allow Subscription Updates	顧客が Customer Portal を通じて、既存のサブスクリプションをいつでもアップグレードまたはダウングレードできるようにします。	無効
Allow Immediate Cancellation	顧客がサブスクリプションを終了し、すぐにアクセス権を失うことを許可します。	有効
Allow Cancellation at Next Billing Date	顧客がすでに支払った期間の終了時にキャンセルできるようにします。	有効
Allow Subscription Pause	顧客が Customer Portal から自分のサブスクリプションを一時停止・再開できるようにします。	無効
Bill Usage at Pause	使用量ベースのサブスクリプションを一時停止した時点で、未請求の使用量を請求します。使用量を次回の通常の請求書に繰り越しません。	有効
Prevent Trial Misuse	すでにトライアルを利用した顧客を、新しいトライアルではなく、有料かつトライアルなしの購入に変更します。	無効
Payment Method Reminder	Card-Optional at Zero Price サブスクリプションの顧客に支払い方法の追加を依頼するメールを、請求開始の何日前に送信するか（1〜30日）。	3日

Customer Portal を通じたプラン変更は、デフォルトで無効です。Settings → Subscriptions で “Allow Subscription Updates” を有効にすると、顧客が同じコレクション内の商品間でアップグレードまたはダウングレードできるようになります。

2つのキャンセル設定は独立しているため、顧客にはすでに支払った期間を使い切ることだけを許可し、即時キャンセルは自分で処理することも、その逆も可能です。一方を無効にすると、Customer Portal でそのオプションが非表示になり、Customer Portal API からのリクエストも拒否されます。Merchant 側で行うキャンセルには影響しません。サブスクリプションのキャンセルを参照してください。

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

トライアル利用の照合・記録方法について詳しくは、トライアルの不正利用防止を参照してください。

“Payment Method Reminder” は、Card-Optional at Zero Price が有効なサブスクリプションにのみ関係します。カードがすでに必須のサブスクリプションには影響しません。リマインダーを無視した場合の動作を含む一連の流れについては、カードがない場合の動作を参照してください。

Subscription Plan Changes

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

コレクションの管理

ダッシュボードまたは API を通じてプログラムからコレクションを管理します。

ダッシュボードでの操作

Create: 商品とグループを含む新しいコレクションを設定します。
Update: 名前、説明、画像、商品の構成を変更します。
Reorder: ドラッグ＆ドロップで商品の表示順を変更します。
Enable/Disable products: チェックアウトに表示する商品を制御します。
Archive: コレクションを完全に削除せず非表示にします（後でアーカイブ解除できます）。

Product Collection のダッシュボードのスクリーンショット。コレクション管理の操作が表示されています

API 管理

次のエンドポイントを使用して、ネストされたグループや商品の管理を含む、Product Collection の作成、更新、取得、アーカイブ、整理をプログラムから行います。

Listing Product Collections

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

List Product Collections API

List Product Collections API のドキュメントで、リクエストとレスポンスの詳細な構造を確認できます。

Creating a Product Collection

名前、説明、ブランドなどの詳細を含む POST リクエストを /product-collections エンドポイントに送信して、新しい 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

グループを使用すると、コレクション内の商品を整理できます（例: “Monthly Plans” と “Annual Plans”）。groups のエンドポイントを使用して、コレクション内のグループを追加、更新、削除します。

Create a group: POST /product-collections/{id}/groups
Update a group: PATCH /product-collections/{id}/groups/{group_id}
Delete a group: DELETE /product-collections/{id}/groups/{group_id}

Create Group

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

Update Group

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

Delete Group

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

Managing Products within a Group

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

Add products to a group: POST /product-collections/{id}/groups/{group_id}/items
Update a group item: PATCH /product-collections/{id}/groups/{group_id}/items/{item_id}
Delete a group item: DELETE /product-collections/{id}/groups/{group_id}/items/{item_id}

Add Products to Group

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

Update Group Item

グループ内の商品項目を更新します。

Delete Group Item

グループから商品項目を削除します。

ベストプラクティス

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

Products

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

Checkout

統一されたcheckoutエクスペリエンスでコレクションの商品を表示します。

Customer Portal

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

Subscriptions

prorationとプラン変更を使用して、継続プランを管理します。

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

主なハイライト

Product Collection の作成