Can I Use Restricted Keys For Stripe Access?

Can I Use Restricted Keys For Stripe Access?

When you add a Stripe connection to your workspace, you can choose to use a restricted key.

This allows you to safeguard your Stripe environment by:
  1. Limiting access to read-only mode
  2. Limiting access to those entities required to calculate commissions
  3. Identifying which caller submits calls to the Stripe API

To generate a restricted key:
  1. Login to Stripe
  2. Generate a restricted key
    1. Click on "Developers"
    2. Click on "API Keys"
    3. Click on "+ Restricted Key"
    4. Enter a key name (ex: "Sales Cookie")
    5. Select read-only permissions for specific entities


Here are our recommendations in terms of selecting entities:
  1. We recommend providing read only access to the following entities as they are commonly used in commission calculations (the exact list depends on your commission structure and the underlying required data):
    1. Customers
    2. Credit notes
    3. Charges
    4. Events
    5. Invoices
    6. Orders
    7. Payment Intents
    8. Prices
    9. Products
    10. Radar Reviews
    11. SKUs
    12. Sources
    13. Subscriptions
    14. Transactions
    15. Balance
    16. Balance Transaction Sources
    17. Tax Rates
    18. Tax Calculations and Transactions
    19. Tax Settings and Registrations
  2. You may also want to enable read only access to the following optional entities (this depends on your commission structure):
    1. Authorizations
    2. Customer session
    3. Cards
    4. Cardholders
    5. Coupons
    6. Disputes
    7. Quotes
  3. We typically do not not require access to the following entities:
    1. Tokens
    2. Token Network Data
    3. Payment Methods (unless you need this information for commissions)
    4. Login Links
    5. Payment Links
    6. Payouts
    7. Files
    8. Funding Instructions
    9. Transfers
    10. Apple Pay domains
    11. Ephemeral keys
    12. Connection Tokens
    13. Webhook Endpoints
    14. Report Runs and Report Types
    15. Debugging tools

To keep it simple, you can enable broad read-only access to the following categories:
  1. Core
    1. To access Customers, Products, Payment Intents, etc.
  2. Billing
    1. To access to Credit Notes, Invoices, etc.
  3. Connect
    1. To access Accounts
  4. Orders
    1. Required if invoices are linked to orders
  5. Payment Records
    1. To access the payments
  6. Radar
    1. Charges typically have links to Radar reviews, so it's not possible to retrieve charges details without this permission
  7. Tax
    1. Access to tax rates and settings

You can then enter the secret restricted API key in Sales Cookie under Settings > Connections > Stripe.

To learn more about connections, click here.
To learn more about managing synchronizations, click here.
To learn more about importing transactions, click here.