Skip to content
Create account
or
Sign in
The Stripe Docs logo
/
Ask AI
Create account
Sign in
Get started
Payments
Revenue
Platforms and marketplaces
Money management
Developer resources
Overview
Versioning
Changelog
Upgrade your API version
Upgrade your SDK version
Essentials
SDKs
API
Testing
Stripe CLI
Sample projects
Tools
Workbench
Developers Dashboard
Stripe Shell
Stripe for Visual Studio Code
Features
Workflows
Event Destinations
Stripe health alertsFile uploads
AI solutions
Agent toolkit
Model Context Protocol
Security and privacy
Security
Stripebot web crawler
Privacy
Extend Stripe
Build 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
    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
      Action buttons
      Onboarding flow
      Additional context
      Back link
      Communicating state
      Demo content
      Empty state
      Lists
      Loading
      Progress stepping
      Redirects
      Settings sign-in
      Sign-in template
      Sign out
      Waiting screens
    Components
Use apps from Stripe
Partners
Partner ecosystem
Partner certification
HomeDeveloper resourcesBuild Stripe appsDesign patterns

Onboarding for Stripe Apps

Learn how to build an onboarding flow for your Stripe app users.

Before you begin

Create an app.

Best practices

The ideal onboarding flow is:

  • Effortless: Users can onboard quickly and easily, while staying focused on their immediate task and providing only necessary information.
  • Customizable: Onboarding can scale up or down based on user needs. Make sure the flow is versatile, yet focused.
  • Relevant: Users can complete the most important tasks so they can start using the app.

Onboarding flow

Enable users to use your app as quickly as possible with minimal setup. Keep the onboarding flow brief and include authorization to connect your users’ Stripe accounts to your product.

If users must complete setup tasks before using the app, use the OnboardingView component in the onboarding modal viewport to clearly communicate the required setup tasks.

Note

You can’t use the OnboardingView component for new feature guidance, promotional offers, or to display large documents unrelated to onboarding.

For each onboarding step, show users a primary action to continue to the next step, such as “Continue.”

Sign in flow

Detect whether the user already has an account for your product and allow them to enter a sign in flow. The sign in flow must provide the path of least resistance and avoid unnecessary steps, as shown in the following example:

If users must sign in as part of the setup process, use the SignInView component as a step during onboarding.

If users must sign in to an external site, be sure to collect sensitive credentials on that site and not within the Stripe Dashboard. This helps to avoid compromising passwords.

Always redirect users back to Stripe after sign in is complete.

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