Back-end app example

Build a Stripe app that performs back-end processing with no user interface.

This guide shows you how to build a back-end Stripe app. It doesn’t provide any user interface other than the default app settings page.

Select the authentication type that you want to use. If you want to build a private app, you can’t use OAuth authentication.

The following example shows how to build a Stripe app that uses platform key authentication.

Create a Stripe account

Stripe を導入する前に、Stripe アカウントを作成する必要があります。

メールアドレス、氏名、国を入力し、パスワードを作成してアカウントを作成します。
ビジネスプロフィールを入力します。
ダッシュボードでメールアドレスを確認をクリックします。Stripe から、アカウントに登録されているメールアドレス宛に確認メールが送信されます。
メールアドレスを確認

メモ

You can continue building your app in a sandbox as you follow the steps in this guide. You need a live Stripe account to publish your app.

Install Stripe CLI and Apps CLI Plugin

# Install Homebrew to run this command: https://brew.sh/
brew install stripe/stripe-cli/stripe

# Connect the CLI to your dashboard
stripe login

# Install Apps CLI Plugin
stripe plugin install apps

See the additional instructions to verify that you’re using CLI v1.12.4 and that node.js is up to date.

Create your app

stripe apps create {my-app-name}

After you run this command, it prompts you for the following:

An app ID, which must be globally unique and can change
An app display name, which doesn’t need to be unique and that you can change

Configure your app

In your new directory, find the stripe-app.json app manifest file, and update it as follows:

{
   "id": "com.example.example-app", // unique app ID
   "version": "0.0.1",  	 // app version
   "name": "Example App",  // app display name
   "icon": "./[YOUR_APP]_icon_32.png",	// app icon; put the file in the same directory for ease of distribution
   "stripe_api_access_type": "platform",
   "allowed_redirect_uris": ["https://example.com/installed/callback"], // optional redirect URLs
   "distribution_type": "public", // for a private app, set to "private"
   "sandbox_install_compatible": "true",
   "permissions": []
}

Configure installation redirect URLs (optional)

In the allowed_redirect_uris array, add the URLs to return your app users to after they install your app from an install link. The first entry becomes the default. If you don’t want to create an install link, you don’t have to include this array in your app manifest.

Configure app permissions

In the permissions array, include the necessary object and event permissions for your use case. For example, accessing the Customers API needs the customer_read permission.

Enter each permission as an object with both a permission and a purpose. Stripe uses the purpose string during app review.
Include only the permissions that your app needs.

Implement server-side logic

You can implement back-end functionality such as:

Integrating securely with external systems
Handling Stripe events with webhooks
Making signed Stripe API calls
Scheduling actions

For detailed instructions, see Add server-side logic.

Upload, test, and publish your app

The process for uploading, testing, and publishing your app depends on whether you want to publish your app to the Stripe App Marketplace or keep it private to your own account.

Upload your app

In the Stripe CLI, run stripe login to confirm that you’re logged into the correct Stripe account. Then run stripe apps upload to upload the app to your Stripe account.
In your Stripe Dashboard, open the Developers menu and select Created apps.
Click your app to open its details page, then select the External test tab.
Click Get started to set up an external test.
Copy the sandbox link.
In a new browser tab, load the sandbox link. It opens the app install page, which lists your app’s permissions.

Enable sandbox testing

After you upload an app into your live account, Stripe auto-generates a managed sandbox account for testing. Your managed sandbox has its own API keys.

To test your app in the sandbox, enable it for sandbox installation.

Publish your app

After Stripe completes the app review and approves the app for publication, you can publish it:

In your Stripe Dashboard, open the Developers menu and select Created apps.
Click your app to open its details page.
Under Publish app, click Review and publish.

Make sure to test your app completely before publishing it.

After you publish your app, it becomes discoverable on marketplace.stripe.com.