Stripe Integration Overview

About the Integration

The Stripe integration provides insights into Customers, paid Invoices, Invoice Line-Items, and Product data. Data is imported into ClientSuccess in real time. 

The integration is only a pull from Stripe. There is no capability to push data from ClientSuccess to Stripe.

Prerequisites

To integrate Stripe with ClientSuccess, you must have an admin-level API key from Stripe. This can be found in the Stripe Developers menu > API keys.

Functionality

The integration provides the following functionality:

1. Map Customer level data to ClientSuccess Clients
   • A new customer created in Stripe can be automatically imported into ClientSuccess
   • Data imported from Stripe includes: Stripe ID, Customer name, Address
   • Other Stripe Customer data such as Balance can be imported into custom fields
2. Map Product level data to ClientSuccess Products
   • A new product created in Stripe can be automatically imported into the ClientSuccess product catalog (found in Global Settings > Products menu)
   • Data imported from Stripe includes: Stripe ID, Product name, Description, Active flag
3. Map paid Invoice level data to ClientSuccess Contracts
   • An invoiced set to "Paid" status in Stripe can be automatically imported into ClientSuccess
   • Data imported from Stripe includes Stripe ID, Invoice Line Items (Products), Quantity, Dates, Amount, Discount 

Getting Started

1. Authenticate the Stripe Integration in ClientSuccess from the Integrations menu using a "secret", not publishable, API key.  You will want to make sure your API key has prefix "sk".  More information at Stripe 

2. Configure which Stripe object ClientSuccess should use to create Contracts: "INVOICE" and/or "SUBSCRIPTION" and how many days back ClientSuccess should pull Invoices (under "Settings")

3. CUSTOMER: (OPTIONAL) Configure field mappings for Customer ONLY if you want to pull over customers from Stripe.  If you are importing customers from a CRM, CSV import, manual entry, etc., then set the customer Sync Direction to "DISABLED".
The screenshot below shows the default Customer mapping with the required fields.

4. (contract) PRODUCT: (OPTIONAL) Configure field mapping for Contract Products if you want to import products from Stripe into the ClientSuccess product catalog.  Here is an example product imported from Stripe into ClientSuccess.

5. CONTRACT: There is no field mapping configuration steps for Contracts (AKA Stripe Invoices) or Line Items.

6. Enable the integration sync.  Run initial import of customers (if applicable), then products (if applicable), and finally contracts (highly recommended that this is completed with your CSM)