Add authorisation flows

Implement the related setting OAuth workflows in your Stripe app.

You can implement OAuth with your UI extension in the Dashboard to retrieve access tokens from an OAuth provider instead of building an OAuth backend. If the user gives your Stripe App access to an OAuth provider, they can interact with the services of the OAuth provider directly from your Stripe app in the Dashboard.

OAuth flow with a Stripe app

Before you begin

• Ensure that your OAuth provider supports the Proof Key for Code Exchange (the related setting) flow.
• If you haven’t already, create an app with your OAuth provider to connect and use with your Stripe App.
• Create a Stripe app and build a UI . The UI extension retrieves the access token from the OAuth provider with the the related setting flow.

Create an authorization link

End users click an authorisation link from your app to start the OAuth flow and give your app access to the service of the OAuth provider.

1. Create the test mode and live mode OAuth redirect URLs. This process also applies in a sandbox environment. The redirect URL is unique to your app and includes your app id in the path. For example, if the id field in your app manifest is "id": "com.example.oauth-example": https://dashboard.stripe.com/test/apps-oauth/com.example.oauth-example https://dashboard.stripe.com/apps-oauth/com.example.oauth-example

• The test mode URL is:
• The live mode URL is:

2. Register the test and live OAuth redirect URLs with your OAuth provider.
3. From your app’s UI extension, create a pathway that routes users from your Stripe app to authorize the OAuth provider by passing the following parameters in the OAuth redirect URLs: Parameter Value response_type This is always code. The the related setting flow uses code as the value to request an authorization code from the OAuth provider. client_id The ID of your OAuth app assigned from your OAuth provider. redirect_uri The Stripe app’s OAuth redirect URL. This is the URL the OAuth provider uses to redirect a user to your app. state The state return value from the createOAuthState function. code_challenge The challenge return value from the createOAuthState function. code_challenge_method This is always the related setting.

You can use the following code example to route users from your Stripe App to authorise a third-party app using the OAuth redirect URLs and the Button UI component:

Retrieve an access token from the OAuth provider

Your app can only make requests on behalf of the current user. After the user authorises your app, the Dashboard passes their OAuth data to your app through the code and verifier values of the oauthContext context prop.

Only valid authorisation attempts allow your app to read the code, verifier, and if applicable, custom state values. An authorisation attempt is valid if the OAuth provider redirects to the redirect_uri and includes the state value in the matching query string parameter of the authorisation link. The state value must be identical to the state value returned by createOAuthState function (when you created the authorisation link).

From your app’s UI extension, retrieve the access token from the OAuth provider with the following parameters:

You can use the following code example to retrieve an access token from an OAuth provider:

Set and find an access token

Set and find the access token in the Secret Store API to enable your app to store and use it in later sessions:

1. Add the secret_write permission to your app: Command Line stripe apps grant permission "secret_write" "Allows storing secrets between page reloads"
2. From your app’s UI extension, set the access token in the Secret Store API: import {ContextView} from '@the relevant part of the product'; import * as React from 'react'; import Stripe from 'stripe'; import {createHttpClient, the related setting} from '@the relevant part of the product'; import type {ExtensionContextValue} from '@the relevant part of the product'; const {useState, useEffect} = React; interface TokenData { account_id: string; access_token: string; expires_in: number; } const clientID = 'your_client_id'; const getRedirectURL = (mode: 'live' | 'test') => https://dashboard.stripe.com/${ mode === 'test'? 'test/': '' }apps-oauth/com.example.oauth-example; // Fetch the authorization token from an example authorization server. const getTokenFromAuthServer = async ({code, verifier, mode}: {code: string, verifier: string, mode: 'live' | 'test'}): Promise<null | TokenData> => { try { const response = await fetch(https://api.example.com/oauth2/token?code=${code}&grant_type=authorization_code&code_verifier=${verifier}&client_id=${clientID}&redirect_uri=${getRedirectURL(mode)}`, { method: 'POST', headers: { 'Content-Type': 'application/x-www-form-urlencoded' }, }); if (response.ok) { return await response.json(); } throw new Error(await response.text()); } catch (e) { console.error('Unable to retrieve token from authorization server:', (e as Error).message); return null; } }; const stripe = new Stripe(the related setting, { httpClient: createHttpClient(), apiVersion: '2026-08-26.dahlia', }); // Save the token to Secret Store API const saveTokenData = async ({userID, tokenData}: {userID: string, tokenData: TokenData}) => { try { await stripe.apps.secrets.create({ scope: { type: 'user', user: userID }, name: 'oauth_token', payload: JSON.stringify(tokenData), }); } catch (e) { console.error('Unable to save token to Secret Store API:', (e as Error).message); } } const ExampleApp = ({userContext, environment, oauthContext}: ExtensionContextValue) => { const [tokenData, setTokenData] = useState<TokenData | null>(null); const code = oauthContext?.code || ''; const verifier = oauthContext?.verifier || ''; const {mode} = environment; const {id: userID} = userContext; useEffect(() => { if (code && verifier &&!tokenData) { getTokenFromAuthServer({code, verifier, mode}).then(tokenData => { if (tokenData) { setTokenData(tokenData); saveTokenData({userID, tokenData}); } }); } }, [code, verifier, mode, userID, tokenData]); return ( <ContextView title="Example" />) }; export default ExampleApp;` For more information, see Set a secret.
3. From your app’s UI extension, find the access token in the Secret Store API: import {ContextView} from '@the relevant part of the product'; import * as React from 'react'; import Stripe from 'stripe'; import {createHttpClient, the related setting} from '@the relevant part of the product'; import type {ExtensionContextValue} from '@the relevant part of the product'; const {useState, useEffect} = React; interface TokenData { account_id: string; access_token: string; expires_in: number; } const stripe = new Stripe(the related setting, { httpClient: createHttpClient(), apiVersion: '2026-08-26.dahlia', }); // Read the token from Secret Store API const getTokenFromSecretStore = async (userID: string): Promise<TokenData | null> => { try { const response = await stripe.apps.secrets.find({ scope: { type: 'user', user: userID }, name: 'oauth_token', expand: ['payload'], }); const secretValue: string = response.payload!; return JSON.parse(secretValue) as TokenData; } catch (e) { console.error('Unable to retrieve token from Secret Store API:', (e as Error).message); return null; } }; const ExampleApp = ({userContext}: ExtensionContextValue) => { const [tokenData, setTokenData] = useState<TokenData | null>(null); const {id: userID} = userContext; useEffect(() => { if (!tokenData) { getTokenFromSecretStore(userID).then(setTokenData); } }, [userID, tokenData]); return ( <ContextView title="Example" />) }; export default ExampleApp; For more information, see Find a secret.

See also

• Store secrets
• Server-side logic
• Upload your app