ツールキットの CSV リファレンス

このガイドは、Billing 移行ツールキットで CSV ファイルを指定する際に役立ちます。以下の例に表示されているタイムスタンプは、すべて Unix エポック形式です。また、サンドボックス内で使用できるテスト用の顧客 ID と価格 ID も用意されています。

CSV の前提条件

CSV ファイルを作成またはダウンロードする前に、以下を把握していることを確認してください。

移行のユースケース

該当する場合は、次の移行のユースケースをお客様独自の移行に適用できます。

• さまざまな料金体系モデルのサブスクリプションを移行する
• さまざまなタイプの支払い回収方法でサブスクリプションを移行する
• サブスクリプションサイクルのさまざまな段階でサブスクリプションを移行する
• 税金が発生するサブスクリプションを移行する
• 割引のあるサブスクリプションを移行する
• Stripeアカウント内のサブスクリプションを移行する
• 複数のフェーズがあるサブスクリプションを移行する

Stripe が提供する任意の CSV テンプレート (基本、複数価格アイテム、単発価格) を必要に応じて以下の例と組み合わせることができます。

さまざまな料金体系モデルのサブスクリプションを移行する

月額 100 USD の基本プランや、月額 200 USD の高度なプランなどの定額の料金体系のサブスクリプションを移行できます。これらのサブスクリプションには、1 つ以上のラインアイテムを設定できます。

例 1 (基本): 2024 年 1 月 1 日から開始される、数量 2 の基本的な 100 USD の月次サブスクリプションを移行します。このサブスクリプションは、デフォルトの支払い方法を使用して自動的に請求されます。

例 2 (複数価格のアイテム): 2024 年 1 月 1 日に開始される以下のサブスクリプションを移行し、デフォルトの支払い方法を使用して自動的に請求されるようにします。

• 数量 2 の基本的な 100 USD の月次サブスクリプション
• 数量 1 の高度な 200 USD の月次サブスクリプション

例 3 (基本): 2024 年 1 月 1 日に開始される以下のサブスクリプションを移行し、デフォルトの支払い方法を使用して自動的に請求されるようにします。

• 数量 2 の基本的な 100 USD の月次サブスクリプション
• 20 USD の単発の請求書の追加手数料

固定価格の金額がない場合には、単発の価格を使用してサブスクリプションを移行することもできます。

例 4 (単発の価格): 2024 年 1 月 1 日に開始される以下のサブスクリプションを移行し、デフォルトの支払い方法を使用して自動的に請求されるようにします。

• 数量 1 の 153 USD の単発の月次サブスクリプション

さまざまなタイプの支払い回収方法でサブスクリプションを移行する

移行したサブスクリプションの支払いは、保存されているデフォルトの支払い方法を使用して自動的に回収するか、顧客が期日までに支払うことができる請求書を送信して回収できます。

例 1 (基本): 2024 年 1 月 1 日から開始される、数量 1 の年間 500 USD のサブスクリプションを移行し、デフォルトの支払い方法を使用して自動的に請求されるようにします。

例 2 (基本): 2024 年 1 月 1 日から開始される、数量 1 の年間 500 USD のサブスクリプションを移行します。このサブスクリプションは、顧客に送信される請求書を使用して請求され、期日は 30 日です。

サブスクリプションサイクルのさまざまな段階でサブスクリプションを移行する

例 1 (基本): 更新が必要なサブスクリプションを移行します。たとえば、更新日が 2024 年 1 月 1 日の 100 USD の月次サブスクリプションを移行します。このサブスクリプションは毎月 1 日に更新されます。

• start_date を現在の更新日に設定することで、サブスクリプションが直ちに請求されるようになります。
• billing_cycle_anchor を次回の更新サイクル日に設定します。
• proration_behavior を none に設定します。

例 2 (基本): 請求サイクルの途中の有料のサブスクリプションを移行します。たとえば、元の開始日が 12 月 25 日の 100 USD の月次サブスクリプションを移行します。移行日は 1 月 1 日で、このサブスクリプションは毎月 25 日に更新されます。

• backdate_start_date をサブスクリプションの元の開始日に設定します。
• billing_cycle_anchor を次回の更新日に設定します。
• start_date に移行日を設定します。
• proration_behavior を none に設定すると、顧客に再度請求することを避け、次回の請求サイクルまでサブスクリプションを予定を設定済みの状態に保つことができます。

例 3 (基本): トライアル期間があるサブスクリプションを移行します。たとえば、2024 年 1 月 1 日に開始される基本的な 100 USD の月次サブスクリプションを移行します。このサブスクリプションは 2024 年 1 月 31 日までトライアル中になります。トライアルが終了すると、このサブスクリプションはデフォルトの支払い方法を使用して自動的に請求されます。

例 4 (基本): 期日を過ぎたサブスクリプションを移行します。たとえば、最終サイクル開始日が 12 月 25 日で、まだ支払われていない 100 USD の月次サブスクリプションを移行します。1 月 1 日に開始されるサイクルの途中でこれを移行し、更新日を毎月 25 日にします。これにより、1 月 1 日から 1 月 25 日までの比例配分を適用した請求書が作成され、Stripe が支払いの回収を試行できます。

有効なサイクル内にあり、以前のシステムでまだ支払われていないサブスクリプションを移行するには、proration_behavior を create_prorations に設定し、すぐに請求書を作成して支払いを回収します。これにより、支払いがまだ未払いの場合、サブスクリプションは Stripe の督促フローにも組み込まれます。

例 5: サイクルの終了時にキャンセルする必要があるサブスクリプションを移行します。移行後、移行のタイミング (サイクルの途中または更新時) に基づいて、これらのサブスクリプションに請求するかどうかを選択できます。

これらはその期間の終了時にキャンセルされます。たとえば、2024 年 1 月 1 日に開始される基本的な 100 USD の月次サブスクリプションを移行します。このサブスクリプションは 2024 年 1 月 31 日に自動的にキャンセルされます。

税金が発生するサブスクリプションを移行する

例 1 (基本): サブスクリプションを移行し、Stripe Taxを有効にして税金を自動計算します。たとえば、2024 年 1 月 1 日に開始される 100 USD の月次サブスクリプションを移行し、Stripe Tax を有効にして税金を自動計算します。

移行ツールキットは、事前に Stripe Tax を有効にしたかどうか、および税金を自動計算するために必要なフィールドを顧客が入力したかどうかを検証します。移行の前に、顧客が必要な情報を提供していることを確認します。

例 2 (基本): 手動税率を使用して、サブスクリプションを移行して税金を計算します。たとえば、2024 年 1 月 1 日に開始される基本的な $100 の月次サブスクリプションを移行し、手動税率を使用して 10% の税金を適用します。

• ダッシュボード (商品カタログ > クーポン) で 10% の手動税率を作成します。
• 移行の CSV テンプレートで税率 ID を使用します。

例 3 (基本): Avalara や Verex などの外部の税金プロバイダを使用する場合:

税金がすでに計算されている移行済みのサブスクリプションでは、CSV で automatic_tax と default_tax_rate の両方を空白のままにします。

サブスクリプションが移行されて本番環境になると、Billing の実装で新しいサブスクリプションに設定した税金の実装ワークフローが自動的に適用されます。

割引があるサブスクリプションを移行する

現在、移行ツールキットは 1 つのサブスクリプションにつき 1 つのクーポンのみをサポートします。

例 1 (基本): 移行後に適用される割引付きのサブスクリプションを移行できます。たとえば、10% の永久割引が適用される、2024 年 1 月 1 日開始の $100 の月次サブスクリプションを移行するには、以下のようにします。

• ダッシュボードで 10% のクーポンを作成します 商品カタログ > クーポン)。
• 移行の CSV ファイルでクーポン名を使用します。

Stripe アカウント内でサブスクリプションを移行する

サブスクリプションを特定の Stripe アカウントから別のアカウントに移行する際の手順は、サードパーティーシステムから移行する際の手順と同じものです。Billing 移行ツールキットを使用してサブスクリプションを移行します。 CSV ファイルのサブスクリプションデータを、以前の Stripe アカウントからエクスポートする必要があります。

例 1 (基本): Stripe 内での移行のための移行 CSV を作成するには、次のようにします。

1. ダッシュボードを使用して以前の Stripe アカウントからサブスクリプションをエクスポートします。
2. 新旧の Stripe アカウント間のフィールドのマッピングには、以下の CSV の例を参考にしてください。

複数のフェーズでサブスクリプションを移行する

移行ツールキットは、サブスクリプションに複数のフェーズを直接追加することをサポートしていません。以下のアプローチをお勧めします。

1. 移行ツールキットを使用して、サブスクリプションの初期フェーズを移行します。
2. 移行後に、移行後のサブスクリプションスケジュールにその他のフェーズを追加します。これを行うには、更新エンドポイントを呼び出すか、Stripe のサブスクリプションダッシュボードを使用します。
3. 移行の start_date を調整して、予定を設定済みのステータス変更から本番環境のステータス変更までに十分な時間を確保します。これにより、サブスクリプションを本番環境に移行する前にフェーズを更新できます。

CSV 仕様 の詳細