
Stripe を使用して請求書を送信する
Made by Stripe
Stripe Payments プラットフォームを使用して、ブランド化可能な購入者宛請求書を作成し、送信します。
この拡張機能の動作
この拡張機能を使用すると、Payments プラットフォーム Stripeでブランド化可能な購入者宛請求書を作成して送信できます。
請求書は、Stripe で設定された会社のロゴや色のテーマを使用して自動的にカスタマイズされます。請求書の送信後は、Stripe ダッシュボードを使用し、詳細なレポートとチャート機能を介して、購入者が支払を済ませたかどうかや処理された金額を追跡できます。
この拡張機能は、指定された Cloud Firestore コレクションで新しいドキュメントをリッスンします(下の例を参照)。ドキュメントが追加されると、Stripe はそのドキュメント内の請求書情報を使ってシステム内で請求書を作成した後、ドキュメントで指定されたメールアドレスにそれを送信します。オプションで、Firebase Authentication ユーザー ID を使用して、購入者のメールアドレスを管理できます。
メール: "customer@example.com", 品目: [{ amount: 2000, currency: "usd", quantity: 2, // Optional, defaults to 1. description: "Growth plan" }]
カスタマイズされた請求書の例を以下に示します。
領収明細書とカードか銀行振込による支払オプションを示す請求書ページ
この拡張機能のオプション機能は、Cloud Firestore ドキュメント内の請求書のステータスを自動的に更新することです。拡張機能のインストール後にこのオプション機能を構成するには、Stripe 請求書イベントをリッスンする Stripe Webhook を登録します。このオプション機能を使用する場合、インストール中はパラメータ [Stripe Webhook シークレット] を空のままにします。その後、登録した Webhook の実際の値を使用してインストール済みの拡張機能を再構成します。このプロセスに関する詳細がインストール後に提供されます。
追加の設定
この拡張機能をインストールする前に、Firebase プロジェクトで以下の Firebase サービスを設定します。
- Cloud Firestore: 請求書情報とオプションで請求書ステータスを保存します。
- ドキュメント内の手順に沿って、Cloud Firestore データベースを作成します。
- Firebase Authentication: オプションでメールと購入者データを管理します。
- Firebase コンソールでユーザーに提案するログイン方法を有効にします。
この拡張機能をインストールする前に、Stripe アカウントと Stripe API キーも用意しておく必要があります。
注: Stripe には、実際の支払を行わずに API を呼び出せるテストモードがあります。この拡張機能を Stripe のテストモードで使用するには、テストモード キーを使用するように拡張機能の [Stripe API キー] パラメータを設定します(拡張機能の構成中に)。テストモード キーは rk_test_12345
のような形式ですが、ライブモード キーは rk_live_12345
のようになります。この拡張機能には Stripe の customers
リソースと invoices
リソースに対する書き込みアクセス権のみが必要なため、シークレット キーを使用するのではなく、これらのリソースに限定されたアクセス権を持つ 制限付きキー を作成することが推奨されています。
料金
この拡張機能は、関連する料金が発生する可能性のある以下の Firebase サービスを使用します。
- Cloud Firestore
- Cloud Functions
- Firebase Authentication(オプション)
この拡張機能は、以下のサードパーティ サービスも使用します。
- Stripe の料金(価格情報)
これらのサービスの使用に関連する費用については、すべてお客様の負担となります。
Firebase に関する注意
この拡張機能をインストールするには、Firebase プロジェクトを Blaze(従量課金制)プランに含める必要があります。使用したリソース分のみが請求されます。ほとんどの Firebase サービスで、少量の使用のための無料枠が用意されています。Firebase の料金の詳細を確認してください。
2020 年 8 月 17 日から、この拡張機能をインストールまたは再構成すると、小額(通常は $0.10 未満)が課金されます。詳細な説明については、Cloud Functions for Firebase の料金に関する FAQ を参照してください。
この拡張機能をインストールする方法
Firebase CLI の使用
拡張機能のインストールと管理は、Firebase CLI でも行えます。
ステップ 1: 以下の npm コマンドを実行して、CLI をインストールするか、最新バージョンの CLI に更新します。
npm install -g firebase-tools正常に機能しない場合は、Firebase CLI リファレンスを確認するか、npm のアクセス権を変更してください。
ステップ 2: 新しい Firebase プロジェクトのディレクトリを設定するか、既存のプロジェクト ディレクトリに移動します
ステップ 3: 次を実行して、この拡張機能を拡張機能のマニフェストに追加します
firebase ext:install stripe/firestore-stripe-invoices --local --project=projectId_or_alias
ステップ 4(任意): Firebase Emulator Suite を使用して、この拡張機能をローカルでテストします
firebase emulators:start
ステップ 5: マニフェストにある拡張機能をプロジェクトにデプロイします
firebase deploy --only extensions --project=projectId_or_alias