{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-agen-for-work/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["Notification","LightboxImage"]},"type":"markdown"},"seo":{"title":"Stripe integration","siteUrl":"https://developers.frontegg.com/","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"stripe-integration","__idx":0},"children":["Stripe integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Stripe is a payment processing platform that provides APIs for accepting payments, managing subscriptions, and handling invoices. Integrating Stripe with Frontegg allows your application to manage customers, charges, payment intents, invoices, products, prices, subscriptions, and refunds on behalf of your users through API key authentication."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Notification","attributes":{"title":"Prerequisites","type":"attention"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A Stripe account (free or paid plan)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Access to the Stripe Dashboard"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"connect-stripe","__idx":1},"children":["Connect Stripe"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-1-open-the-api-keys-page","__idx":2},"children":["Step 1: Open the API keys page"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Log in to your ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://dashboard.stripe.com"},"children":["Stripe Dashboard"]},". In the bottom toolbar, click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Developers"]},", then select the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API keys"]}," tab. This page displays your existing keys and allows you to create new restricted keys."]},{"$$mdtype":"Tag","name":"LightboxImage","attributes":{"isLightbox":true},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/stripe-1.c2d510622fba3ae40685e8577c20c42ce96b6bd8f913513609b2009730e0ac55.1ce25488.png","alt":"Stripe API keys page"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-2-create-a-restricted-key","__idx":3},"children":["Step 2: Create a restricted key"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Restricted keys"]}," section, click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create restricted key"]}," button. A dialog appears asking how you will use this API key. Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Building your own integration"]}," and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Continue"]},"."]},{"$$mdtype":"Tag","name":"LightboxImage","attributes":{"isLightbox":true},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/stripe-2.078f5d9c10154572c5a7ee12b3f9e303b80f4532e19eed0d3dd1263411d51f44.1ce25488.png","alt":"Create a restricted key dialog"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-3-name-the-key","__idx":4},"children":["Step 3: Name the key"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["On the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create restricted API key"]}," page, enter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Frontegg Integration"]}," (or any descriptive name) in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key name"]}," field."]},{"$$mdtype":"Tag","name":"LightboxImage","attributes":{"isLightbox":true},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/stripe-3.12f98c2b671da188dda4836ef61eeca3a51e84dfd414504f8de7d76baf051152.1ce25488.png","alt":"Key name field"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-4-set-core-permissions","__idx":5},"children":["Step 4: Set Core permissions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Core"]}," section of the permissions table, set the following resource types to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]}," (which also grants Read access):"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource type"},"children":["Resource type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Permission"},"children":["Permission"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customers"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Write"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Charges and Refunds"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Write"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Payment Intents"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Write"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Products"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Write"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Leave all other Core resource types set to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["None"]},"."]},{"$$mdtype":"Tag","name":"LightboxImage","attributes":{"isLightbox":true},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/stripe-4.735cb6008816fcfbdf81224662d378911b2015803a28300450323b5e34933a45.1ce25488.png","alt":"Stripe Core permissions"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-5-set-billing-permissions","__idx":6},"children":["Step 5: Set Billing permissions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Scroll down to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Billing"]}," section and set the following resource types to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource type"},"children":["Resource type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Permission"},"children":["Permission"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invoices"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Write"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Prices"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Write"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Subscriptions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Write"]}]}]}]}]},{"$$mdtype":"Tag","name":"Notification","attributes":{"title":"Minimum required permissions","type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For read-only access, set the resource types above to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Read"]}," instead of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Write"]},". Write permission is required for creating or modifying records."]}]},{"$$mdtype":"Tag","name":"LightboxImage","attributes":{"isLightbox":true},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/stripe-5.561e67f7f5a62b89c03232385faf9633c3adcfeef384468684234564242dcb79.1ce25488.png","alt":"Stripe Billing permissions"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-6-create-the-key","__idx":7},"children":["Step 6: Create the key"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Scroll to the bottom of the page and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create key"]},". The restricted key is now created and appears in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Restricted keys"]}," section of the API keys page."]},{"$$mdtype":"Tag","name":"Notification","attributes":{"title":"Keep your credentials secure","type":"attention"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can only reveal a restricted API key once. Copy it immediately after creation and store it in a safe location. Never share or commit your API key to version control."]}]},{"$$mdtype":"Tag","name":"LightboxImage","attributes":{"isLightbox":true},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/stripe-6.c2d510622fba3ae40685e8577c20c42ce96b6bd8f913513609b2009730e0ac55.1ce25488.png","alt":"Stripe restricted key created"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"step-7-copy-the-key-token","__idx":8},"children":["Step 7: Copy the key token"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click the copy icon next to the restricted key token to copy it to your clipboard. You will need this key to configure the integration in the Frontegg portal."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"configure-the-frontegg-portal","__idx":9},"children":["Configure the Frontegg portal"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you have your restricted API key from the steps above, enter it in the integration configuration page of the Frontegg portal:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Frontegg portal"]}," and navigate to [ENVIRONMENT] → Integrations → Stripe."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API key"]}," in the corresponding field."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select the required ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["scopes"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"additional-resources","__idx":10},"children":["Additional resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.stripe.com/keys"},"children":["Stripe API keys documentation"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.stripe.com/keys#limit-access"},"children":["Stripe restricted keys guide"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.stripe.com/api"},"children":["Stripe API reference"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/agen-for-work/connectors/redirect-url"},"children":["How to get your Redirect URL"]}]}]}]}]},"headings":[{"value":"Stripe integration","id":"stripe-integration","depth":2},{"value":"Connect Stripe","id":"connect-stripe","depth":3},{"value":"Step 1: Open the API keys page","id":"step-1-open-the-api-keys-page","depth":4},{"value":"Step 2: Create a restricted key","id":"step-2-create-a-restricted-key","depth":4},{"value":"Step 3: Name the key","id":"step-3-name-the-key","depth":4},{"value":"Step 4: Set Core permissions","id":"step-4-set-core-permissions","depth":4},{"value":"Step 5: Set Billing permissions","id":"step-5-set-billing-permissions","depth":4},{"value":"Step 6: Create the key","id":"step-6-create-the-key","depth":4},{"value":"Step 7: Copy the key token","id":"step-7-copy-the-key-token","depth":4},{"value":"Configure the Frontegg portal","id":"configure-the-frontegg-portal","depth":3},{"value":"Additional resources","id":"additional-resources","depth":3}],"frontmatter":{"seo":{"title":"Stripe integration"}},"lastModified":"2026-05-01T18:45:25.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/agen-for-work/connectors/marketplace/stripe","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}