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
Versioning
Changelog
Upgrade your API version
Upgrade your SDK version
Developer tools
SDKs
API
Testing
Workbench
Event Destinations
Workflows
Stripe CLI
Stripe Shell
Developers Dashboard
Agent toolkit
Stripe health alertsBuild with LLMsStripe for Visual Studio CodeFile uploads
Security
Security
Extend Stripe
Stripe Apps
    Overview
    Get started
    Create an app
    How Stripe Apps work
    Sample apps
    Build an app
    Store secrets
    API authentication methods
    Authorisation flows
    Server-side logic
    Listen to events
    Handle different modes
    Enable sandbox support
    App settings page
    Build a UI
    Onboarding
    Distribute your app
    Distribution options
    Upload your app
    Versions and releases
    Test your app
    Publish your app
    Promote your app
    Add deep links
    Create install links
    Assign roles in UI extensions
    Post-install actions
    App analytics
    Embedded components for Apps
    Embed third-party Stripe Apps
    Migrating to Stripe Apps
    Migrate or build an extension
    Migrate a plugin to Stripe Apps or Stripe Connect
    Reference
    App manifest
    CLI
    Extension SDK
    Permissions
    Viewports
    Design patterns
    Components
Stripe Connectors
Partners
Partner ecosystem
Partner certification
HomeDeveloper toolsStripe Apps

Test your app externally

Set up and distribute test versions of your app before publication.

Copy page

Note

External testing is currently only available for public apps.

You can set up an external test to enable other accounts to install your app before you publish and distribute a new version to the App Marketplace.

Before you begin

  1. Create your app.
  2. Review the mandatory App review requirements.
  3. Upload your app in test mode.
  4. There is a limit of 25 testers per app. Limit the use of external tests for testing purposes only.

Set up an external test

Set up test app

Invite users in the Dashboard

  1. From the Developer’s Dashboard > Apps, select the app you want to test externally.
  2. Click the External test tab, then click Get Started.
    • If you don’t see the External test tab, verify if you’ve selected public distribution from Create a release.
  3. Complete the following fields to configure external testing (which you can edit at any time):
    • Link access: Choose whether anyone can install the app using the link or to restrict to invited users only.
    • Version: Select a version for users to install. If you change the version, all current users will be updated to the new version.
  4. Click the invite link to copy it, and send to users for them to install on their account. These users must have administrator rights to install the app.
    • Apps using OAuth have separate live mode and test mode install links. Send the correct link to your users based on their use case.

Result: After a user installs the test version of your app, all members of the account can use it.

The location of test OAuth links within the Stripe Dashboard

Update the version of your test app

  1. From the Developer’s Dashboard > Apps, select the app you want to test externally.
  2. Click the External test tab, then click Edit.
  3. Select a new version of your app from the dropdown, and click Save.

Result: After you save, all test apps of current users will automatically update to the new version.

Evaluating your test app

You must inform your users that test apps are still in development and haven’t been reviewed by Stripe. Users should only install apps from developers they trust.

Installing the test app

After the tester opens the invite link, Stripe redirects them to the following page in the Stripe Dashboard:

Installation invite

Installation invite

After the user installs the app, all members on the account can use it. If the published version of the app is already installed on the account, it needs to be uninstalled before the test version can be installed.

Using the test app

After installation, the app displays in the dock on the right side of the Dashboard. After the tester opens the test app, there is a test version badge next to the app name. They can hover over this badge to learn more about the app and the testing criteria.

Using test app

Test app in dock

Leaving the test

If users no longer want to evaluate a test app, they must select it from Settings > Installed Apps and uninstall it. If the published version of the app was previously installed on the account, users can reinstall the app from the App Marketplace.

Uninstall test app

Settings page

Ending the test

Currently, we don’t support ending external testing with the Stripe Dashboard. Instead, to end a test of an app, you must upload a new version of the app to disable the functionality. After this update, the new test version is available for external testing.

See also

  • Publish your app
  • App review requirements
Was this page helpful?
YesNo
Need help? Contact Support.
Join our early access programme.
Check out our changelog.
Questions? Contact Sales.
LLM? Read llms.txt.
Powered by Markdoc