Stripe Appsを公開アプリとしてアップロードする際の、distribution_typeに関する注意点 #stripe

Stripe Appsでは、作成したアプリを第三者がインストールして利用できるようにする公開設定が行えます。公開したアプリは、Stripe App Marketplaceからインストールできるようになります。

初めてStripe Appsアプリをアップロードする際の注意点

Stripe Appsアプリを初めてstripe apps uploadでアップロードする際、stripe-app.jsonのdistribution_type設定内容に関わらず、「プライベートアプリ」として１度アップロードされます。

そのため、次のようにdistribution_type=publicを設定していた場合、stirpe apps uploadコマンドを実行すると、distribution_typeが削除されます。

{
  "id": "com.example.wordpress-plugin-oauth",
  "version": "0.0.2",
  "name": "Example Wordpress Plugin",
  "icon": "",
  "permissions": [
    {
      "permission": "customer_read",
      "purpose": "List the customer names"
    }
  ],
  "ui_extension": {
    "views": [
      {
        "viewport": "stripe.dashboard.customer.detail",
        "component": "App"
      }
    ],
    "content_security_policy": {
      "connect-src": null,
      "image-src": null,
      "purpose": ""
    }
  },
  "allowed_redirect_uris": [
    "https://hidetaka.dev/callback"
  ],
-  "distribution_type": "public"
}

なぜ初回アップロードは、プライベートアプリ扱いになるのか

これはStripeのシステム制約からくるもので、意図しない公開アプリのアップロードを防止するためです。Stripe AppsアプリはStripeアカウントに紐づいて管理されています。そして各Stripeアカウントでは公開アプリを一つしか持てないため、誤ってテスト目的で作成したアプリを公開設定にしてしまった場合、本来公開する予定でいたアプリを、そのStripeアカウントでアップロードすることができなくなります。

公開設定は、「2回目の`stripe apps upload`」で実施する

まず初めに、stripe apps uploadを実行して初期バージョンをアップロードします。そして、次にStripe CLIで"distribution_type": "public"の指定を追加し、再アップロードを行います。

$ stripe apps upload
$ stripe apps set distribution_type public

この設定を追加すると、以下のような確認メッセージが表示されて、初めて公開設定を行うための注意事項が表示されます。

$ stripe apps upload

 ⓘ  You have selected public distribution for this app. Please note the
    following:
    * After you upload, you cannot change the distribution to private.
    * You can only upload one public app per Stripe account.

? Would you like to proceed? [y/N] y█

注意点 - アカウントの本番環境が有効化されていること

上記手順で公開設定を行う場合でも、Stripe アカウントが本番環境に有効化されていないと、次のエラーメッセージが表示されてしまいます。

× Failed to upload Example Wordpress Plugin
Request failed, status=400, body={
  "error": {
    "message": "9:Please activate your account to select public distribution.",
    "request_log_url": "https://dashboard.stripe.com/test/logs/req_M1a4rmrgujMU9t?t=1706856009",
    "type": "invalid_request_error"
  }
}

Stripeのアプリを公開配布設定する際は、Stripe アカウントが本番環境に有効化されていることを確認するようにしましょう。

Stripe Appsを公開アプリとしてアップロードする際の、distribution_typeに関する注意点

初めてStripe Appsアプリをアップロードする際の注意点

なぜ初回アップロードは、プライベートアプリ扱いになるのか

公開設定は、「2回目のstripe apps upload」で実施する

注意点 - アカウントの本番環境が有効化されていること

関連するStripeドキュメント記事

公開設定は、「2回目の`stripe apps upload`」で実施する