Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Billing Usage API #246

Open
github-product-roadmap opened this issue Sep 8, 2021 · 0 comments
Open

Billing Usage API #246

github-product-roadmap opened this issue Sep 8, 2021 · 0 comments

Comments

@github-product-roadmap
Copy link
Collaborator

@github-product-roadmap github-product-roadmap commented Sep 8, 2021

Summary

Today, customers can access billing usage data via our in product UI and a CSV report. The current usage data displayed in the Billing UI isn't granular enough for many customers to gain relevant insights (such as identifying top spending repos) and pulling information from the CSV is very manual and time consuming.

The billing usage API will allow Enterprise admins to programmatically access their Enterprise account's detailed billing and usage data so they can more easily understand their usage.

Intended Outcome

Customers can more easily analyze usage, create custom reports and integrate with existing BI tools.

How will it work?

Enterprise Admins can retrieve the following information from our APIs:

  • Total spend for Enterprise account
  • Total entitlements usage for Enterprise account
  • Total remaining prepaid credits for Enterprise account
  • Total spend and usage for Enterprise account by service
  • Total spend and usage per org
  • Total spend and usage per service per org / total spend per org per service
  • Total spend and usage per service per repo / total spend per repo per service
  • Total spend relative to budget (Actions/Packages and Codespaces)
  • Total enterprise licenses purchased & SKU type/plan (i.e. GHE, GHE-C, GHE-S, etc)
  • Total enterprise licenses consumed by license type (standalone vs bundle) & state (accepted, pending, etc.)
  • If Bundle licenses purchased, total licenses matched with VS subscribers

APIs will return data up to 180 days, customizable by the customer via parameter input with a default of 30 days.

Example API call and response

image

@github github locked and limited conversation to collaborators Sep 8, 2021
@github-product-roadmap github-product-roadmap added this to Q4 2021 – Oct-Dec in GitHub public roadmap Sep 8, 2021
@github-product-roadmap github-product-roadmap moved this from Q4 2021 – Oct-Dec to Future in GitHub public roadmap Oct 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant