Docs

Using Stripe's restricted keys

You can use Stripe's Restricted API keys instead of Secret keys. Creating Stripe-Restricted keys is straightforward. Here we provide both the TL;DR and the detailed versions.

TLDR version

  1. Navigate to this link OR Developers > Create Restricted Key and give an identifiable name to the restricted key. You may want to name this Reveal and give Chargebee as the website (if Stripe asks for this).
  2. Copy this restricted key and store it in a secure and retrievable place.
  3. On the Reveal dashboard you will be asked for:
    • Secret Key: Enter the restricted key copied in Step 2.
    • Publishable key: Copy the publishable key from Developers > API keys or this link on the Stripe dashboard.
    • Alias: Enter an identifier (business name or MID) for this Stripe account corresponding to the keys.

Here is the list of permissions to provide for every RESOURCE TYPE.

RESOURCE TYPEPERMISSIONSCONNECT PERMISSIONS
All core resourcesReadRead
All Checkout resourcesReadRead
All Billing resourcesReadRead
All Connect resourcesRead-
All Orders resourcesReadRead
All Reporting resourcesReadRead
All webhook resourcesWrite-
Stripe CLI permissionsNoneNone
All Payment Links resourcesNoneNone
All Terminal resourcesReadRead
TaxReadRead
RadarReadRead
All Climate resourcesReadRead

Longform version

Steps to create restricted keys:

  1. Log in to your Stripe Account.
  2. Go to Developers > Create Restricted Key.
  3. Provide a Key Name. This is an identifier of your choice.
  4. In the resource type, provide Write Access to All Webhook Resources.
  5. In the same resource type section, provide Read access to the following resources:
    • All Core Resources
    • All Checkout Resources
    • All Billing Resources
    • All connect resources
    • All Order resources
    • Stripe CLI permissions
    • All Payment Link Resources
    • Tax
    • Terminal Resources
    • Radar
    • Climate resources
    • All Reporting Resources
  6. Click on Create Key in the bottom right corner of the screen.
  7. Copy the Keys and store it in a secure and retrievable place.
  8. Use this restricted key along with the publishable key in your Reveal dashboard to add Stripe as a source.

Was this article helpful?