Skip to main content

GitHub Marketplace API에 대한 웹후크 이벤트

GitHub Marketplace 앱은 Marketplace 구매 이벤트 웹후크에서 사용자의 플랜 변경에 대한 정보를 받습니다. Marketplace 구매 이벤트는 사용자가 결제 플랜을 구매, 취소 또는 변경할 때 트리거됩니다.

참고: 이 문서는 GitHub Marketplace의 앱 게시에만 적용됩니다. GitHub Actions의 GitHub Actions 배포에 대한 자세한 내용은 "GitHub Marketplace에서 작업 게시"을(를) 참조하세요.

웹후크 및 GitHub Marketplace 정보

웹후크 POST 요청에는 특별한 헤더가 있습니다. 자세한 내용은 "웹후크 이벤트 및 페이로드"을 참조하세요. GitHub는 제공 시도가 실패하면 다시 전송하지 않습니다. 앱이 GitHub에서 보낸 모든 웹후크 페이로드를 받을 수 있는지 확인합니다. GitHub Marketplace 웹후크를 만들고 사용하지 않도록 설정하는 방법에 대한 자세한 내용은 "웹후크 만들기" 및 "웹후크 사용 중지하기"을(를) 참조하세요.

취소 및 다운그레이드는 다음 청구 기간의 첫 날에 적용됩니다. 다운그레이드 및 취소에 대한 이벤트는 새 플랜이 다음 청구 기간의 시작 부분에 적용될 때 전송됩니다. 새 구매 및 업그레이드에 대한 이벤트는 즉시 시작됩니다. 웹후크 페이로드에서 effective_date를 사용하여 변경이 시작되는 시점을 확인합니다.

참고: 스팸 GitHub Marketplace 구매 또는 기타 악의적인 동작을 알아챈 경우 사용자에 대한 자세한 정보를 사용하여 신고하기 양식을 작성하세요.

GitHub Marketplace에 대한 구매 웹후크 페이로드 정보

marketplace_purchase 웹후크 페이로드에는 다음 정보가 있습니다.

형식설명
actionstring웹후크를 생성하기 위해 수행된 작업. purchased, cancelled, pending_change, pending_change_cancelled 또는 changed일 수 있습니다. 자세한 내용은 아래 웹후크 페이로드 예제를 참조하세요. 참고:pending_changepending_change_cancelled 페이로드는 페이로드 예제changed에 표시된 것과 동일한 키를 포함하고 있습니다.
effective_datestringaction이 적용되는 날짜
senderobject웹후크를 트리거한 action을 수행한 사람
marketplace_purchaseobjectGitHub Marketplace 구매 정보

marketplace_purchase 개체에는 다음 키가 있습니다.

형식설명
accountobject구독과 연결된 organizationuser 계정. 조직 계정에는 조직의 관리 메일 주소인 organization_billing_email이(가) 포함됩니다. 개인 계정의 메일 주소를 찾으려면 인증된 사용자 가져오기 엔드포인트를 사용할 수 있습니다.
billing_cyclestringyearly 또는 monthly일 수 있습니다. account 소유자가 무료 GitHub 플랜을 사용 중이고 무료 GitHub Marketplace 플랜을 구입하면 billing_cyclenil입니다.
unit_countinteger구매한 단위 수
on_free_trialbooleanaccount가 평가판을 사용 중이면 true
free_trial_ends_onstring평가판이 만료될 날짜
next_billing_datestring다음 청구 기간이 시작되는 날짜. account 소유자가 무료 GitHub.com 플랜을 사용 중이고 무료 GitHub Marketplace 플랜을 구입하면 next_billing_datenil입니다.
planobjectuser 또는 organization이 구매한 플랜

plan 개체에는 다음 키가 있습니다.

형식설명
idinteger플랜의 고유 식별자
namestring플랜의 이름
descriptionstring플랜에 대한 설명
monthly_price_in_centsinteger플랜의 월별 비용(단위: 미국 통화 센트). 예를 들어 매월 10달러의 비용이 드는 목록은 1000센트가 됩니다.
yearly_price_in_centsinteger플랜의 연간 비용(단위: 미국 통화 센트). 예를 들어 매월 100달러의 비용이 드는 목록은 120000센트가 됩니다.
price_modelstring이 목록의 가격 책정 모델. FLAT_RATE, PER_UNIT 또는 FREE 중 하나일 수 있습니다.
has_free_trialboolean목록이 평가판을 제공하는 경우 true
unit_namestring단위의 이름. 가격 책정 모델이 per-unit이 아닌 경우에는 nil입니다.
bulletarray of strings가격 책정 플랜에 설정된 글머리 기호의 이름