Skip to content

Latest commit

 

History

History
97 lines (50 loc) · 6.54 KB

README.md

File metadata and controls

97 lines (50 loc) · 6.54 KB
Raw

Send Invoices using Stripe

Author: Stripe (https://stripe.com)

Description: Creates and sends brandable customer invoices using the Stripe payments platform.

Details: Use this extension to create and send brandable customer invoices using the payments platform Stripe.

The invoices are automatically customized with the logo and color theme of your business that you've set up in Stripe. After the invoice is sent, you can use the Stripe dashboard to track whether the customer has paid and how much money you processed with detailed reporting and charts.

This extension listens to your specified Cloud Firestore collection for new documents (like the example below). When you add a document, Stripe uses the invoice information in the document to create an invoice in their system then sends the invoice to the email address specified in the document. You can optionally manage your customer email addresses using Firebase Authentication user IDs.

email: "[email protected]",
items: [{
    amount: 2000,
    currency: "usd",
    quantity: 2, // Optional, defaults to 1.
    description: "Growth plan"
}]

Here's an example of what your customized invoice will look like!

An invoice page showing an itemized receipt, with options to pay with card or bank transfer

An optional feature of this extension is to automatically update the invoice's status in its Cloud Firestore document. You can configure this feature after installing the extension by registering a Stripe webhook that listens for Stripe invoice events. If you want to use this optional feature, leave the parameter Stripe webhook secret empty during installation, then reconfigure your installed extension later with the actual value for your registered webhook. More details about this process are provided after installation.

Additional setup

Before installing this extension, set up the following Firebase services in your Firebase project:

You must also have a Stripe account and a Stripe API key before installing this extension.

Note: Stripe has a test mode that lets you make API calls without making actual payments. To use this extension with Stripe's test mode, set the extension's Stripe API key parameter (during extension configuration) to use a test mode key. A test mode key looks like rk_test_12345, whereas a live mode key would be rk_live_12345. As this extension only requires write access to your Stripe customers and invoices resources, we recommend that you create a restricted key with limited access to only these resources rather than using your secret key.

Billing

This extension uses the following Firebase services which may have associated charges:

  • Cloud Firestore
  • Cloud Functions
  • Firebase Authentication (optional)

This extension also uses the following third-party services:

You are responsible for any costs associated with your use of these services.

Note from Firebase

To install this extension, your Firebase project must be on the Blaze (pay-as-you-go) plan. You will only be charged for the resources you use. Most Firebase services offer a free tier for low-volume use. Learn more about Firebase billing.

Starting August 17 2020, you will be billed a small amount (typically less than $0.10) when you install or reconfigure this extension. See the Cloud Functions for Firebase billing FAQ for a detailed explanation.

Configuration Parameters:

  • Cloud Functions deployment location: Where do you want to deploy the functions created for this extension? You usually want a location close to your database. For help selecting a location, refer to the location selection guide.

  • Invoices collection: What is the path to the Cloud Firestore collection where you'll store your invoices?

  • Stripe API key with restricted access: What is your Stripe API key for sending invoices? We recommend creating a new restricted key with write access only for the customers and invoices resources. If desired, you can optionally use a test mode API key for initial testing of your extension, but you'll need to later reconfigure your extension to use a live mode key. Learn more about API keys in your Stripe dashboard.

  • Days until payment is due: What is the default number of days the customer has before their payment is due? The invoice automatically closes after this number of days. You can override this default value for each invoice.

  • Stripe webhook secret: This is your signing secret for a Stripe-registered webhook that updates each Cloud Firestore document with the invoice's status from the Stripe dashboard. This webhook can only be registered after installation. To use this optional feature, leave this value empty during installation, then follow the postinstall instructions for registering your webhook and configuring this value.

Cloud Functions:

  • sendInvoice: Creates a Stripe Invoice when a new invoice document is created in your specified Cloud Firestore collection

  • updateInvoice: If registered as a Stripe webhook, this function updates the appropriate invoice document in Cloud Firestore when a new Stripe Event is received.

Access Required:

This extension will operate with the following project IAM roles:

  • firebaseauth.viewer (Reason: Allows the extension to find the email of a user based on their Firebase Authentication user ID.)

  • datastore.user (Reason: Allows the extension to update invoices in Cloud Firestore with data from Stripe.)