跳至主要内容

向客户计费

GitHub Marketplace 上的应用应遵守 GitHub 的计费指南并支持推荐的服务。遵循我们的指南可以帮助客户在没有意外的情况下完成计费流程。

注意:本文档仅适用于在 GitHub Marketplace 上发布应用。有关在 GitHub Marketplace 上发布 GitHub Actions 的更多信息,请参阅“在 GitHub Marketplace 上发布 Actions”。

了解计费周期

客户在购买您的应用时可以选择每月或每年计费周期。客户对计费周期和计划选择的任何更改都会触发 marketplace_purchase 事件。您可以参考 marketplace_purchase webhook 负载查看客户选择的计费周期以及下一个计费日期的开始时间 (effective_date)。有关 webhook 负载的更多信息,请参阅“GitHub Marketplace API 的 webhook 事件”。

在应用的 UI 中提供计费服务

客户应该能够从您的应用网站执行以下操作

  • 客户应该能够分别修改或取消其个人和组织帐户的 GitHub Marketplace 计划。
  • 从 GitHub Marketplace 取消付费计划的客户应自动降级到应用的免费计划(如果存在)。当客户取消 GitHub Marketplace 订阅时,GitHub 不会自动卸载应用,因此客户可以预期免费功能将继续运行。强烈建议允许客户重新启用其之前的计划。
  • 如果您在应用界面中提供 升级 URL,则客户可以通过应用界面升级。升级 URL 格式如下:https://www.github.com/marketplace/<LISTING_NAME>/upgrade/<LISTING_PLAN_NUMBER>/<CUSTOMER_ACCOUNT_ID>
  • 如果客户购买了席位(按单位计费计划)或计划提供无限协作者,则他们可以通过应用网站修改哪些用户可以访问您的应用。
  • 客户应该能够在应用网站的账单、个人资料或帐户设置部分立即看到以下帐户更改。
    • 当前计划和价格。
    • 购买的新计划。
    • 升级、降级、取消以及免费试用剩余的天数。
    • 计费周期更改(每月或每年)。
    • 固定费率和按单位计费计划的用量和剩余资源。例如,如果计费计划是按单位计费,则您的应用网站应显示已使用的单位和可用的单位。

升级、降级和取消的账单服务

请遵循以下有关升级、降级和取消的指南,以维护清晰一致的账单流程。有关 GitHub Marketplace 购买事件的更详细说明,请参阅“在您的应用中使用 GitHub Marketplace API”。

您可以使用 marketplace_purchase webhook 的 effective_date 键来确定计划更改何时生效,并定期同步 列出计划的帐户

升级

当客户升级其计费计划或将其计费周期从每月更改为每年时,您应该立即对其生效。您需要对新计划应用按比例折扣并更改计费周期。

如果客户升级其计划但付款失败,GitHub 会将其 GitHub Marketplace 订阅恢复到之前的状态。GitHub 还会向客户发送电子邮件,告知他们失败并允许他们重新尝试购买。您将收到一个带有 changed 操作的 webhook,要求您恢复到之前的计划。

有关将升级和降级工作流程构建到您的应用中的信息,请参阅“处理计划更改”。

降级和取消

降级是指客户从付费计划转到免费计划,选择比当前计划价格更低的计划,或将账单周期从每年改为每月。降级或取消发生时,您无需提供退款。相反,当前计划将在当前账单周期的最后一天之前保持有效。当客户下一个账单周期的开始生效新计划时,将发送 marketplace_purchase 事件。

当客户取消计划时,您必须

  • 自动将其降级到免费计划(如果存在)。

    当客户取消 GitHub Marketplace 订阅时,GitHub 不会自动卸载应用程序,因此客户可以预期免费功能将继续运行。

  • 允许他们通过 GitHub 升级计划,以便他们可以在以后继续使用该计划。

有关将取消工作流程构建到您的应用程序中的信息,请参阅“处理计划取消”。