Carga do webhook de compra no GitHub Marketplace
As solicitações POST de webhooks têm cabeçalhos especiais. Confira "Cabeçalhos de entrega de webhook" para obter mais detalhes. O GitHub não reenvia tentativas de entrega com falha. Certifique-se de que seu aplicativo possa receber todas as cargas de webhook enviados pelo GitHub.
Os cancelamentos e downgrades entram em vigor no primeiro dia do próximo ciclo de cobrança. Os eventos para downgrades e cancelamentos são enviados quando o novo plano entra em vigor no início do próximo ciclo de cobrança. Os eventos referentes às novas compras e atualizações entram em vigor imediatamente. Use a effective_date na carga de webhook para determinar quando uma alteração será iniciada.
Observação: se você observar compras do GitHub Marketplace com spam ou outro comportamento mal-intencionado, preencha o formulário de denúncias de abuso com mais informações sobre o usuário.
Cada carga de webhook marketplace_purchase terá as seguintes informações:
| Chave | Tipo | Descrição |
|---|---|---|
action | string | A ação realizada para gerar o webhook. Pode ser purchased, cancelled, pending_change, pending_change_cancelled ou changed. Para obter mais informações, consulte o exemplo de cargas de webhook abaixo. Observação: as cargas pending_change e pending_change_cancelled contêm as mesmas chaves mostradas no exemplo de conteúdo changed. |
effective_date | string | A data em que a action se torna efetiva. |
sender | object | A pessoa que executou a action que disparou o webhook. |
marketplace_purchase | object | Informações de compra do GitHub Marketplace. |
O objeto marketplace_purchase tem as seguintes chaves:
| Chave | Tipo | Descrição |
|---|---|---|
account | object | A conta organization ou user associada à assinatura. As contas da organização incluirão organization_billing_email, que é o endereço de email administrativo da organização. Para encontrar endereços de email para contas pessoais, use o ponto de extremidade Obter o usuário autenticado. |
billing_cycle | string | Pode ser yearly ou monthly. Quando o proprietário da account tiver um plano gratuito do GitHub e tiver comprado um plano gratuito do GitHub Marketplace, o billing_cycle será nil. |
unit_count | integer | Número de unidades compradas. |
on_free_trial | boolean | true quando a account estiver em uma avaliação gratuita. |
free_trial_ends_on | string | A data em que o teste grátis expirará. |
next_billing_date | string | A data em que começará o próximo ciclo de faturamento. Quando o proprietário da account tiver um plano gratuito do GitHub.com e tiver comprado um plano gratuito do GitHub Marketplace, a next_billing_date será nil. |
plan | object | O plano comprado pelo user ou pela organization. |
O objeto plan tem as seguintes chaves:
| Chave | Tipo | Descrição |
|---|---|---|
id | integer | O identificador exclusivo para este plano. |
name | string | O nome do plano. |
description | string | Descrição deste plano. |
monthly_price_in_cents | integer | O preço mensal deste plano em centavos (moeda americana). Por exemplo, uma listagem que custa 10 dólares por mês será 1000 centavos. |
yearly_price_in_cents | integer | O preço anual deste plano em centavos (moeda americana). Por exemplo, uma listagem que custa 100 dólares por mês será 120 mil centavos. |
price_model | string | O modelo de preço para esta listagem. Pode ser flat-rate, per-unit ou free. |
has_free_trial | boolean | true quando essa listagem oferecer uma avaliação gratuita. |
unit_name | string | O nome da unidade. Se o modelo de preços não for per-unit, isso será nil. |
bullet | array of strings | Os nomes dos marcadores estabelecidos no plano de preços. |
Exemplo de carga de webhook para um evento purchased
Este exemplo fornece a carga do evento purchased.
{
"action": "purchased",
"effective_date": "2017-10-25T00:00:00+00:00",
"sender": {
"login": "username",
"id": 3877742,
"avatar_url": "https://avatars2.githubusercontent.com/u/3877742?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/username",
"html_url": "https://github.com/username",
"followers_url": "https://api.github.com/users/username/followers",
"following_url": "https://api.github.com/users/username/following{/other_user}",
"gists_url": "https://api.github.com/users/username/gists{/gist_id}",
"starred_url": "https://api.github.com/users/username/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/username/subscriptions",
"organizations_url": "https://api.github.com/users/username/orgs",
"repos_url": "https://api.github.com/users/username/repos",
"events_url": "https://api.github.com/users/username/events{/privacy}",
"received_events_url": "https://api.github.com/users/username/received_events",
"type": "User",
"site_admin": true,
"email": "username@email.com"
},
"marketplace_purchase": {
"account": {
"type": "Organization",
"id": 18404719,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"login": "username",
"organization_billing_email": "username@email.com"
},
"billing_cycle": "monthly",
"unit_count": 1,
"on_free_trial": false,
"free_trial_ends_on": null,
"next_billing_date": "2017-11-05T00:00:00+00:00",
"plan": {
"id": 435,
"name": "Basic Plan",
"description": "Basic Plan",
"monthly_price_in_cents": 1000,
"yearly_price_in_cents": 10000,
"price_model": "per-unit",
"has_free_trial": true,
"unit_name": "seat",
"bullets": [
"Is Basic",
"Because Basic "
]
}
}
}
Exemplo de carga de webhook para um evento changed
As alterações em um plano incluem atualizações e downgrades. Este exemplo representa as cargas dos eventos changed, pending_change e pending_change_cancelled. A ação identifica qual destes três acontecimentos ocorreu.
{
"action": "changed",
"effective_date": "2017-10-25T00:00:00+00:00",
"sender": {
"login": "username",
"id": 3877742,
"avatar_url": "https://avatars2.githubusercontent.com/u/3877742?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/username",
"html_url": "https://github.com/username",
"followers_url": "https://api.github.com/users/username/followers",
"following_url": "https://api.github.com/users/username/following{/other_user}",
"gists_url": "https://api.github.com/users/username/gists{/gist_id}",
"starred_url": "https://api.github.com/users/username/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/username/subscriptions",
"organizations_url": "https://api.github.com/users/username/orgs",
"repos_url": "https://api.github.com/users/username/repos",
"events_url": "https://api.github.com/users/username/events{/privacy}",
"received_events_url": "https://api.github.com/users/username/received_events",
"type": "User",
"site_admin": true,
"email": "username@email.com"
},
"marketplace_purchase": {
"account": {
"type": "Organization",
"id": 18404719,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"login": "username",
"organization_billing_email": "username@email.com"
},
"billing_cycle": "monthly",
"unit_count": 10,
"on_free_trial": false,
"free_trial_ends_on": null,
"next_billing_date": "2017-11-05T00:00:00+00:00",
"plan": {
"id": 435,
"name": "Basic Plan",
"description": "Basic Plan",
"monthly_price_in_cents": 1000,
"yearly_price_in_cents": 10000,
"price_model": "per-unit",
"has_free_trial": true,
"unit_name": "seat",
"bullets": [
"Is Basic",
"Because Basic "
]
}
},
"previous_marketplace_purchase": {
"account": {
"type": "Organization",
"id": 18404719,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"login": "username",
"organization_billing_email": "username@email.com"
},
"billing_cycle": "monthly",
"on_free_trial": false,
"free_trial_ends_on": null,
"unit_count": 1,
"plan": {
"id": 435,
"name": "Basic Plan",
"description": "Basic Plan",
"monthly_price_in_cents": 1000,
"yearly_price_in_cents": 10000,
"price_model": "per-unit",
"has_free_trial": true,
"unit_name": "seat",
"bullets": [
"Is Basic",
"Because Basic "
]
}
}
}
Exemplo de carga de webhook para um evento cancelled
{
"action": "cancelled",
"effective_date": "2017-10-25T00:00:00+00:00",
"sender": {
"login": "username",
"id": 3877742,
"avatar_url": "https://avatars2.githubusercontent.com/u/3877742?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/username",
"html_url": "https://github.com/username",
"followers_url": "https://api.github.com/users/username/followers",
"following_url": "https://api.github.com/users/username/following{/other_user}",
"gists_url": "https://api.github.com/users/username/gists{/gist_id}",
"starred_url": "https://api.github.com/users/username/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/username/subscriptions",
"organizations_url": "https://api.github.com/users/username/orgs",
"repos_url": "https://api.github.com/users/username/repos",
"events_url": "https://api.github.com/users/username/events{/privacy}",
"received_events_url": "https://api.github.com/users/username/received_events",
"type": "User",
"site_admin": true,
"email": "username@email.com"
},
"marketplace_purchase": {
"account": {
"type": "Organization",
"id": 28536653,
"node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
"login": "organizationUsername",
"organization_billing_email": "organizationusername@gmail.com"
},
"billing_cycle": "monthly",
"unit_count": 0,
"on_free_trial": false,
"free_trial_ends_on": null,
"next_billing_date": "2017-11-08T00:00:00+00:00",
"plan": {
"id": 686,
"name": "Premium Plan",
"description": "Premium Plan",
"monthly_price_in_cents": 10000,
"yearly_price_in_cents": 100000,
"price_model": "flat-rate",
"has_free_trial": true,
"unit_name": null,
"bullets": [
"Is Expensive",
"And Flat Rate"
]
}
}
}