App install
Beta
Show a button to install an App.
Renders a component that enables your connected account to install an App.
For full integration details, see Accounting software integrations.
When creating an Account Session, enable app_install by specifying app_install
in the components
parameter.
Note
The app_install component is in private beta, so the Stripe SDKs don’t include it yet. To enable it when creating an account session, use this code snippet with the Stripe beta SDK:
Stripe.api_key = '{{sk_INSERT_YOUR_SECRET_KEY}}'
Stripe.api_version = '2023-10-16; embedded_connect_beta=v2;'
account_session = Stripe::AccountSession.create({
account: '{{CONNECTED_ACCOUNT_ID}}'
,
components: {
app_install: {enabled: true}
}
})
After creating the account session and initializing ConnectJS, you can render the app_install component in the front end:
import {useCreateComponent, useAttachAttribute} from '@stripe/react-connect-js';
export const ConnectAppInstallWithAttributes = ({
appId,
}: {
appId: string;
}): JSX.Element | null => {
const {wrapper, component: appInstall} = useCreateComponent(
'stripe-connect-app-install' as any
);
useAttachAttribute(appInstall, 'app' as any, appId);
return wrapper;
};
This embedded component supports the following parameters:
Setter | Type | Description |
---|
setApp | string | Sets the ID of the App your connected account can install. See available apps here. |
setOnAppInstallStateFetched | () => void | Stripe sends this event when the component renders. |
setOnAppInstallStateChanged | () => void | Stripe sends this event when an app finishes installing or uninstalling. |
Request early access Beta
Sign in to request access to this Connect embedded component in beta.
If you don’t have a Stripe account, you can register now.