Skip to content
Create account
or
Sign in
The Stripe Docs logo
/
Ask AI
Create account
Sign in
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
Developer tools
Get started
Payments
Finance automation
Get started
Payments
Finance automation
Platforms and marketplaces
Money management
Overview
Get started with Connect
Integration fundamentals
Example integrations
Onboard accounts
Configure account Dashboards
    Get started with Connect embedded components
    Supported Connect embedded components
      Available Components
      Account management
      Account onboarding
      Balances
      Documents
      Financial account
      Financial account transactions
      Issuing card
      Issuing cards list
      Notification banner
      Payment details
      Payments
      Payouts
      Payouts list
      Tax registrations
      Tax settings
      Preview components
      App install
      App viewport
      Capital financing
      Capital financing application
      Capital financing promotion
      Disputes for a payment
      Export Tax Transactions
      Payment method settings
      Reporting chart
    Customize Connect embedded components
    Stripe Dashboard customization
    Platform controls for Stripe Dashboard accounts
    Express Dashboard
Accept payments
Pay out to accounts
Manage your Connect platform
Tax forms for your Connect platform
Work with connected account types
HomePlatforms and marketplacesConfigure account DashboardsSupported Connect embedded components

App installPrivate preview

Show a button to install an app.

Copy page

App install renders a component that enables your connected account to install an app. App install is a private preview component that requires using preview versions of Stripe SDKs. Read more about private preview components.

For full integration details, see the Embedded Stripe Apps integration guide.

Create an Account Session

When creating an Account Session, enable the App install component by specifying app_install in the components parameter. You must enable the app you want to install by specifying the features parameter under allowed_apps.

Command Line
cURL
curl https://api.stripe.com/v1/account_sessions \ -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"
\ -H "Stripe-Version: 2025-04-30.basil; embedded_connect_beta=v2;" \ -d account=
{{CONNECTED_ACCOUNT_ID}}
\ -d "components[app_install][enabled]"=true \ -d "components[app_install][features][allowed_apps][]"=APP_ID

After creating the account session and initializing ConnectJS, you can render the App install component in the front end:

app-install.js
JavaScript
const appInstall = stripeConnectInstance.create('app-install'); appInstall.setApp('{{APP_ID}}'); container.appendChild(appInstall);

This embedded component supports the following parameters:

MethodTypeDescription
setAppstringSets the ID of the App your connected account can install. See the list of available apps.

You can configure custom behavior based on the current or updated state of an install.

app-install.js
JavaScript
// index.html <div id="app-install-container"></div> // index.js // Do something when install state fetched on render const handleAppInstallFetched = (response) => { console.log(`Install state fetched for app ${response.appId} to ${response.state}`); }; // Do something when install state changes const handleAppInstallChanged = (response) => { console.log(`Install state changed for app ${response.appId} to ${response.state}`); }; const container = document.getElementById('app-install-container'); const appInstall = stripeConnectInstance.create('app-install'); appInstall.setApp('{{APP_ID}}'); appInstall.setOnAppInstallStateFetched(handleAppInstallFetched); appInstall.setOnAppInstallStateChanged(handleAppInstallChanged); container.appendChild(appInstall);
MethodDescriptionVariables
setOnAppInstallStateFetchedAllows users to specify custom behavior in a callback function on install fetch.
  • response.appId: The app installed
  • response.state: The state of the install INSTALLED | UNINSTALLED
setOnAppInstallStateChangedAllows users to specify custom behavior in a callback function when the install state has changed.
  • response.appId: The app installed
  • response.state: The state of the install INSTALLED | UNINSTALLED

You can integrate our sample app (set APP_ID to stripe.app-explorer), which we’ve pre-approved for embedding on your platform.

Request early access Private preview

Sign in to request access to this Connect embedded component in preview.

If you don’t have a Stripe account, you can register now.

Was this page helpful?
YesNo
Need help? Contact Support.
Join our early access program.
Check out our changelog.
Questions? Contact Sales.
LLM? Read llms.txt.
Powered by Markdoc