Stripe API Key Permissions for ClearSync

Overview

ClearSync requires read-only access to specific Stripe data to synchronize your subscription and billing information with HubSpot. We never modify, create, or delete anything in your Stripe account.

Create a Restricted API Key in Stripe and Configure Permissions

You can use a Stripe Secret key to connect to ClearSync. If you’d prefer to use a Restricted Key, these are the permissions you’ll need to set for ClearSync to be able to read the correct data. To do this,
  1. Log into your Stripe Dashboard
  1. Go to DevelopersAPI Keys
  1. Click Create restricted key
  1. Give it a name like "ClearSync Integration"
  1. In the permissions section, set these exact permissions:
plain text
Core: ✅ Charges - Read ✅ Customers - Read ✅ Events - Read ✅ Payment Intents - Read ✅ Payment Methods - Read ✅ Products - Read Billing: ✅ Coupons - Read ✅ Invoices - Read ✅ Prices - Read ✅ Subscriptions - Read ✅ Connect - Read All webhook: ✅ Webhook Endpoints - Write (This is only so we can create a webhook to read Stripe event data. We will never use this to write data to your Stripe account.) All other resources: ☐ Set to "None"
Once this key is created, share it with your internal teammate so they can connect it to ClearSync and complete the Stripe data import.

How ClearSync Uses Stripe API Key Read Access:

Resource
Permission
Why We Need It
Charges
Read
Access charge details for transaction history and payment tracking
Coupons
Read
Track discounts and promotions for accurate MRR calculations
Customers
Read
Access customer details, email addresses, and company information for HubSpot matching
Events
Read
Monitor real-time subscription and payment events for immediate updates
Invoices
Read
Historical data import and transaction tracking beyond Stripe's 30-day event limit
Payment Intents
Read
Track payment processing status and failed payment recovery
Payment Methods
Read
Display payment method information in customer reports and dashboards
Prices
Read
Calculate Monthly Recurring Revenue (MRR) and track pricing tier changes
Products
Read
Display product names and details in HubSpot reports and dashboards
Subscriptions
Read
Track subscription status, MRR calculations, billing cycles, and lifecycle changes
Connect
Read
Access account-level information for API key validation and account verification
Webhook Endpoint
Write
Create and manage webhook endpoints for real-time data synchronization

Troubleshooting Stripe Access
  • Still have questions? Contact our support team for assistance with setting up Stripe API keys and permissions by emailing support@clearsync.ai.