Using the GitHub Marketplace API in your app

GitHub Marketplace上でのアプリケーションの管理を支援するために、以下のGitHub Marketplace APIエンドポイントを使ってください。

GitHub Marketplaceアプリケーションは、ユーザのプランに対する変更に関する情報を、Marketplaceの購入イベントwebhookから受け取ります。 Marketplaceの購入イベントは、ユーザが支払いプランの購入、キャンセル、変更をした場合にトリガーされます。

リストをGitHub Marketplaceにサブミットする前に、APIとwebhookを使ってアプリケーションをテストし、顧客に理想的な体験を提供できるようにすることをGitHubはおすすめします。 オンボーディングの専門家の検証前に、アプリケーションは支払いフローを適切に処理しなければなりません。

お客様が有料プラン、無料試用版、または GitHub Marketplace アプリの無料バージョンを購入すると、purchased アクションを含む marketplace_purchase イベント Webhook を受け取り、購入フローが開始されます。

GitHub Marketplace アプリをアップグレードまたはダウングレードすると、changed アクションで marketplace_purchase イベント Webhook がトリガーされて、アップグレード フローまたはダウングレード フローが始まります。

GitHub Marketplace アプリをキャンセルすると、cancelled アクションを含む marketplace_purchase イベント Webhook がトリガーされ、キャンセル フローが開始されます。