Publish your app to the Stripe App Marketplace

1. Set your app to the public distribution.

stripe apps set distribution public

This command updates the manifest file with a distribution_type field set to a public value.

{
  "id": "com.example.app",
  "version": "1.2.3",
  "name": "Example App",
  "icon": "./example_icon_32.png",
  "distribution_type": "public"
}

To add your app’s required permissions:

1. Determine which objects your app calls on the Stripe API. If you’re migrating an extension to an app, you must determine which objects your extension (not your app) calls on the Stripe API to understand which permissions to include.
2. See the list of permissions you can add to your app manifest.
3. You can add a permission to the permissions array in your stripe-app.json app manifest file using the following command:

stripe apps grant permission "PERMISSION_NAME" "EXPLANATION"

Populate the prompts with your permission’s information:

• PERMISSION_NAME: The name of the permission you’d like to add. See possible permission names.
• EXPLANATION: Explanation for enabling access. Users see this explanation when they install your app.

Repeat this step for each new permission that you want to add to your application.

To remove a permission, you can also use the CLI:

stripe apps revoke permission "PERMISSION_NAME"

To upload your app, run the following command from your project root directory:

stripe apps upload

Stripe validates your app manifest, then uploads and installs your app to your Stripe test account. You can also configure the app manifest to enable installation in sandbox environments.

After this step:

• Any team member can access your app in test mode at https://dashboard.stripe.com/test/.
• Your app can store secrets in test mode.
• You can access your app’s signing secret to connect it to a backend.

1. Upload a new version of your app after setting the distribution type.

   After you make your distribution choice, Stripe automatically applies it to all future app versions. To change how to distribute your app after you publish it to all Stripe users, contact Stripe at Stripe Support.

2. In the Stripe Dashboard, navigate to Apps, then select your app to see its details page.

3. If your app has multiple versions, choose the app version you want to publish and click Continue. If you can’t select a version, activate your account first.

4. Create your app listing by clicking Edit listing and providing an overview, features, pricing and support, and resource links to help users evaluate your app. As you complete the listing, you can see its preview on the right side of the Dashboard.

   For tips on ensuring app approval and creating a compelling listing, see App listing guidelines.

5. Click Continue to provide the following information before final app submission:

   • Version: If your app has multiple versions, select and verify the version you want to submit for review.
   • Marketplace install URL: This option is required for OAUTH apps and optionally available for apps that support install links. From the Stripe App Marketplace, users are redirected to this URL to install your app.

     Note

     The URL must link to a page that can initiate the onboarding and installation process with clear instructions.

   • Testing credentials: If your app requires sign in, provide at least one test account to allow Stripe to test and review your app. See the example testing credentials.

     Caution

     Stripe does not permit you to use real (non-test) accounts for the app review process.

   • Testing guidance: Provide user scenarios to allow Stripe to simulate the user’s intended installation and usage of your app. To increase your chances of passing app review, see example testing guidance.
   • Contact emails: Provide the email of the recipient for app review updates, and the email of a contact for resolving security incidents.

   Any changes you make after starting the review process are subject to an additional review period. To avoid delays, ensure all information is accurate according to App review requirements before final submission.

6. To start the review process, click Submit for review.

   After Stripe reviews and approves your app, you have the ability to publish it to the Stripe App Marketplace. If you need to make changes, you can cancel your app in review, and Stripe removes your position in the review queue.

   To avoid delays, make sure all information is accurate according to the App review requirements before final submission. After your app is In Review, you won’t be able to withdraw your submission or make changes. After Stripe reviews and approves your app, you can publish it to the Stripe App Marketplace.

After Stripe verifies that your app meets all app review requirements, we send a notification to the contact email and update your app details page with a review decision. If your app requires additional changes, Stripe provides guidance on the changes you need to address for approval. After you implement the changes, you can resubmit your app for another review.

1. After Stripe approves your app, go to the Apps page in the Stripe Dashboard. Select your app, and preview your listing by clicking Review and publish.

   If you decide to make changes, clicking Cancel and edit requires you to resubmit your app for review.

2. To publish and list your app on the Stripe App Marketplace, click Publish.

After this step:

• Any user can discover your app on the Stripe App Marketplace.
• Any Stripe account user can install and use your app.
• You can view app analytics as soon as 24 hours after publication.