App viewportPrivate preview

App viewport renders a view from an installed app.

For full integration details, see Accounting software integrations.

Create an Account Session

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

curl https://api.stripe.com/v1/account_sessions \
  -u "
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:" \
  -H "Stripe-Version: 2024-11-20.acacia; embedded_connect_beta=v2;" \
  -d account=
{{CONNECTED_ACCOUNT_ID}} \
  -d "components[app_viewport][enabled]"=true \
  -d "components[app_viewport][features][allowed_apps][]"=APP_ID

After creating the account session and initialising ConnectJS, you can render the App viewport component in the front end. The view doesn’t render if the app isn’t installed:

const appViewport = stripeConnectInstance.create('app-viewport');
appViewport.setApp('{{APP_ID}}');
appViewport.setAppData({userId: '{{PLATFORM_USER_ID}}'});
container.appendChild(appViewport);

This embedded component supports the following parameters:

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

Read more about App install.

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.