Private preview

App install Private preview

Show a button to install an app.

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

Select a language

cURL

Ruby

Python

PHP

Java

Node.js

.NET

No results

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

app-install.js

Select a language

JavaScript

React

No results

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

This embedded component supports the following parameters:

Method	Type	Description
`setApp`	`string`	Sets 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.

index.html

Select a language

HTML and JavaScript

React

No results

<div id="app-install-container"></div>

index.js

Select a language

HTML and JavaScript

React

No results

// 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);

Method	Description	Variables
`setOnAppInstallStateFetched`	Allows users to specify custom behavior in a callback function on install fetch.	`response.appId`: The app installed `response.state`: The state of the install `the related setting \| the related setting`
`setOnAppInstallStateChanged`	Allows 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 `the related setting \| the related setting`

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

Request early access Private preview

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