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.
  • ClearSync never modifies, creates, or deletes any data in your Stripe account.

Options for Connecting Stripe

Image without caption

Option 1: Install from Stripe Marketplace (Easiest)

By clicking Install on Stripe, you will be prompted to log in to Stripe and install ClearSync, which will then automatically generate a restricted read-only key with the minimum required Stripe permissions as described below.
  • You can then copy/paste that Restricted Key into ClearSync.

Option 2: Share with a Stripe Admin

If you arenโ€™t the Stripe admin, you can share ClearSyncโ€™s install link with an admin so they can install ClearSync in Stripe and automatically generate a Restricted Key with the minimum required permissions.
  • Either you or they can then copy/paste that Restricted Key into ClearSync.

Option 3: Manually create a Restricted API Key in Stripe and Configure Permissions

You can use a Stripe Secret key to connect to ClearSync. Or, if youโ€™d prefer to create and use a Restricted Key to give ClearSync the minimum possible permissions:
  1. Log into your Stripe Dashboard
  1. Go to Developers โ†’ API Keys
  1. Click Create restricted key
  1. Click โ€œProviding this key to another websiteโ€
  1. Give it a name like "ClearSync Integration"
  1. Enter https://www.clearsync.ai for the URL
  1. Check and enable โ€œCustomize permissions for this keyโ€
In the โ€œCreate restricted API keyโ€, set these exact resource permissions:
plain text
Core -- click "None" on the Core Section, then add: โœ… Charges and Refunds - Read โœ… Customers - Read โœ… Events - Read โœ… Payment Intents - Read โœ… Payment Methods - Read โœ… Products - Read Billing -- click "None" on the Billing Section, then add: โœ… Coupons - Read โœ… Credit Notes - Read โœ… Invoices - Read โœ… Prices - Read โœ… Subscriptions - Read โœ… Connect -- (the entire category) - Read โœ… Webhook: Write (This is so ClearSync can create an outging webhook in your Stripe to read event data. ClearSync will never write webhook data to your Stripe account.) โŒ All other resources: None Note: If you have Connect as a second column of permissions options, set all of those to None as well, leaving Connect in the left column set to Read.
  • Once you have the Stripe key, you or a teammate can connect it to ClearSync (Step 5 here) and begin your Stripe data import!
Your Stripe Restricted API key page should look like this when all permissions are set correctly:
Image without caption
How ClearSync Uses Stripe API Key Read Access:

Troubleshooting Stripe Access

Common Permission Issues

Error: "Insufficient permissions to access customers"
  • Ensure Customers - Read is enabled
Error: "Cannot retrieve subscription data"
  • Ensure Subscriptions - Read is enabled
Error: "Historical import failed"
  • Ensure Invoices - Read is enabled
Error: "Product names not displaying"
  • Ensure Products - Read and Prices - Read are enabled
Error: "MRR calculations incorrect with discounts"
  • Ensure Coupons - Read is enabled
If you encounter any issues with API key setup or permissions:
  1. Verify all required permissions are enabled
  1. Ensure you're using a secret or restricted key
  1. Check that the key is for the correct Stripe account (live vs test)
  1. Contact ClearSync support with the specific error message (support@clearsync.ai)
  • Still have questions? Contact our support team for assistance with setting up Stripe API keys and permissions by emailing support@clearsync.ai.