Private preview

App viewport Private preview

Show a view from an installed App.

App viewport renders a view from an installed app. App viewport 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_viewport in the components parameter. You must enable the app you want to render 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 initialising ConnectJS, you can render the App viewport component in the front end. The view doesn’t render if the app isn’t installed:

app-viewport.js

Select a language

JavaScript

React

No results

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:

Method	Type	Description
`setApp`	`string`	Sets the ID of the App your connected account can render. See available apps in the Embedded Stripe Apps integration guide.
`setAppData`	`Record<String, String>`	Sets data pertaining to your platform consumed by the App.

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.