Skip to main content

GitHub Marketplace APIのためのwebhookイベント

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

注: この記事は、GitHub Marketplace でのアプリの公開にのみ適用されます。 GitHub Marketplace での GitHub Actions の公開について詳しくは、「GitHub Marketplaceでのアクションの公開」をご覧ください。

Webhook と GitHub Marketplace について

Webhook の POST 要求には特別なヘッダーがあります。 詳細については、「Webhook のイベントとペイロード」を参照してください。 GitHubは、失敗した配信の試行を再送信しません。 GitHubが送信したすべてのwebhookのペイロードを、アプリケーションが確実に受信できるようにしてください。 GitHub Marketplace Webhook の作成方法と無効にする方法についての詳細は、「webhookの作成」と「Webhook を無効にする」を参照してください。

キャンセル及びダウングレードは、次の支払いサイクルの初日に有効になります。 ダウングレードとキャンセルのイベントは、次の支払いサイクルの開始時に新しいプランが有効になったときに送信されます。 新規の購入とアップグレードのイベントは、すぐに開始されます。 Webhook ペイロードで effective_date を使用して、変更が開始されるタイミングを決定します。

注: スパムのような GitHub Marketplace の購入やその他の悪意のある動作に気付いた場合は、[不正使用を報告] フォームにそのユーザーに関する詳細情報を記入してください。

GitHub Marketplace の購入 Webhook ペイロード

marketplace_purchase Webhook ペイロードには、次の情報が含まれます。

キーType説明
actionstringwebhookを生成するために行われたアクション。 purchasedcancelledpending_changepending_change_cancelled、または changed を指定できます。 詳しい情報については、以下のwebhookペイロードの例を参照してください。 注: pending_changepending_change_cancelled の各ペイロードには、changed ペイロードの例に示されているのと同じキーが含まれています。
effective_datestringaction が有効になる日付。
senderobjectWebhook をトリガーした action を実行した人。
marketplace_purchaseobjectGitHub Marketplaceの購入情報。

marketplace_purchase オブジェクトには、次のキーがあります。

キーType説明
accountobjectサブスクリプションに関連付けられている organization または user のアカウント。 Organization アカウントには、Organization の管理用メール アドレスである organization_billing_email が含まれます。 個人用アカウントのメール アドレスを検索するには、認証されたユーザー エンドポイントの取得を使用できます。
billing_cyclestringyearly または monthly を指定できます。 account の所有者が無料の GitHub プランを持っていて、無料の GitHub Marketplace プランを購入した場合、billing_cyclenil になります。
unit_countinteger購入したユーザ数。
on_free_trialbooleantrue が無料試用版の場合は account
free_trial_ends_onstring無料トライアルが期限切れになる日付。
next_billing_datestring次の支払いサイクルが始まる日付。 account の所有者が無料の GitHub.com プランを持っていて、無料の GitHub Marketplace プランを購入した場合、next_billing_datenil になります。
planobjectuser または organization によって購入されたプラン。

plan オブジェクトには、次のキーがあります。

キーType説明
idintegerこのプランの一意の識別子。
namestringプラン名。
descriptionstringプランの説明。
monthly_price_in_centsintegerこのプランのセント (米国の通貨) 単位の月額。 たとえば、月額10米ドルのリストは1000セントです。
yearly_price_in_centsintegerこのプランのセント (米国の通貨) 単位の年額。 たとえば、月額 100 米ドルのリストは 120000 セントになりす。
price_modelstringこのリストの価格モデル。 FLAT_RATEPER_UNITFREE のいずれかを指定できます。
has_free_trialbooleanこのリストが無料試用版を提供している場合は true
unit_namestringユニットの名前。 価格モデルが per-unit でない場合、これは nil になります。
bulletarray of strings価格プランに設定されている箇条書きの名前。