GitHub REST API Client

View Source GitHub.Billing (GitHub REST API Client v0.3.3)

Provides API endpoints related to billing

Link to this section Summary

Functions

get_github_actions_billing_org(org, opts \\ [])

Get GitHub Actions billing for an organization

get_github_actions_billing_user(username, opts \\ [])

Get GitHub Actions billing for a user

get_github_packages_billing_org(org, opts \\ [])

Get GitHub Packages billing for an organization

get_github_packages_billing_user(username, opts \\ [])

Get GitHub Packages billing for a user

get_shared_storage_billing_org(org, opts \\ [])

Get shared storage billing for an organization

get_shared_storage_billing_user(username, opts \\ [])

Get shared storage billing for a user

Link to this section Functions

Link to this function

get_github_actions_billing_org(org, opts \\ [])

View Source 
@spec get_github_actions_billing_org(
  String.t(),
  keyword()
) :: {:ok, GitHub.Actions.BillingUsage.t()} | {:error, GitHub.Error.t()}

Get GitHub Actions billing for an organization

Gets the summary of the free and paid GitHub Actions minutes used.

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "Managing billing for GitHub Actions".

OAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.

resources

 Resources

Link to this function

get_github_actions_billing_user(username, opts \\ [])

View Source 
@spec get_github_actions_billing_user(
  String.t(),
  keyword()
) :: {:ok, GitHub.Actions.BillingUsage.t()} | {:error, GitHub.Error.t()}

Get GitHub Actions billing for a user

Gets the summary of the free and paid GitHub Actions minutes used.

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "Managing billing for GitHub Actions".

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

resources

 Resources

Link to this function

get_github_packages_billing_org(org, opts \\ [])

View Source 
@spec get_github_packages_billing_org(
  String.t(),
  keyword()
) :: {:ok, GitHub.PackagesBillingUsage.t()} | {:error, GitHub.Error.t()}

Get GitHub Packages billing for an organization

Gets the free and paid storage used for GitHub Packages in gigabytes.

Paid minutes only apply to packages stored for private repositories. For more information, see "Managing billing for GitHub Packages."

OAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.

resources

 Resources

Link to this function

get_github_packages_billing_user(username, opts \\ [])

View Source 
@spec get_github_packages_billing_user(
  String.t(),
  keyword()
) :: {:ok, GitHub.PackagesBillingUsage.t()} | {:error, GitHub.Error.t()}

Get GitHub Packages billing for a user

Gets the free and paid storage used for GitHub Packages in gigabytes.

Paid minutes only apply to packages stored for private repositories. For more information, see "Managing billing for GitHub Packages."

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

resources

 Resources

Link to this function

get_shared_storage_billing_org(org, opts \\ [])

View Source 
@spec get_shared_storage_billing_org(
  String.t(),
  keyword()
) :: {:ok, GitHub.CombinedBillingUsage.t()} | {:error, GitHub.Error.t()}

Get shared storage billing for an organization

Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.

Paid minutes only apply to packages stored for private repositories. For more information, see "Managing billing for GitHub Packages."

OAuth app tokens and personal access tokens (classic) need the repo or admin:org scope to use this endpoint.

resources

 Resources

Link to this function

get_shared_storage_billing_user(username, opts \\ [])

View Source 
@spec get_shared_storage_billing_user(
  String.t(),
  keyword()
) :: {:ok, GitHub.CombinedBillingUsage.t()} | {:error, GitHub.Error.t()}

Get shared storage billing for a user

Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.

Paid minutes only apply to packages stored for private repositories. For more information, see "Managing billing for GitHub Packages."

OAuth app tokens and personal access tokens (classic) need the user scope to use this endpoint.

resources

 Resources