Cobrança

A API de cobrança permite obter informações de cobrança para uma empresa.

About the Billing API

Você pode obter informações de cobrança para uma empresa. Para obter mais informações, consulte a API REST "GitHub administração de Enterprise".

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".

Access tokens must have the repo or admin:org scope.

Parâmetros

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`org`stringObrigatório The organization name. The name is not case sensitive.

HTTP response status codes

Status code	Descrição
`200`	OK

Amostras de código

get/orgs/{org}/settings/billing/actions

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://api.github.com/orgs/ORG/settings/billing/actions

Response

Status: 200

{
  "total_minutes_used": 305,
  "total_paid_minutes_used": 0,
  "included_minutes": 3000,
  "minutes_used_breakdown": {
    "UBUNTU": 205,
    "MACOS": 10,
    "WINDOWS": 90
  }
}

Get GitHub Advanced Security active committers for an organization

Works with GitHub Apps

Gets the GitHub Advanced Security active committers for an organization per repository. Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository. If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.

Parâmetros

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`org`stringObrigatório The organization name. The name is not case sensitive.
Parâmetros de consulta
Nome, Tipo, Descrição
`per_page`integer The number of results per page (max 100). Padrão: `30`
`page`integer Page number of the results to fetch. Padrão: `1`

HTTP response status codes

Status code	Descrição
`200`	Success
`403`	Response if GitHub Advanced Security is not enabled for this repository

Amostras de código

get/orgs/{org}/settings/billing/advanced-security

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://api.github.com/orgs/ORG/settings/billing/advanced-security

Success

Status: 200

{
  "total_advanced_security_committers": 2,
  "total_count": 2,
  "repositories": [
    {
      "name": "octocat-org/Hello-World",
      "advanced_security_committers": 2,
      "advanced_security_committers_breakdown": [
        {
          "user_login": "octocat",
          "last_pushed_date": "2021-11-03"
        },
        {
          "user_login": "octokitten",
          "last_pushed_date": "2021-10-25"
        }
      ]
    },
    {
      "name": "octocat-org/server",
      "advanced_security_committers": 1,
      "advanced_security_committers_breakdown": [
        {
          "user_login": "octokitten",
          "last_pushed_date": "2021-10-26"
        }
      ]
    }
  ]
}

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."

Access tokens must have the repo or admin:org scope.

Parâmetros

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`org`stringObrigatório The organization name. The name is not case sensitive.

HTTP response status codes

Status code	Descrição
`200`	OK

Amostras de código

get/orgs/{org}/settings/billing/packages

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://api.github.com/orgs/ORG/settings/billing/packages

Response

Status: 200

{
  "total_gigabytes_bandwidth_used": 50,
  "total_paid_gigabytes_bandwidth_used": 40,
  "included_gigabytes_bandwidth": 10
}

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."

Access tokens must have the repo or admin:org scope.

Parâmetros

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`org`stringObrigatório The organization name. The name is not case sensitive.

HTTP response status codes

Status code	Descrição
`200`	OK

Amostras de código

get/orgs/{org}/settings/billing/shared-storage

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://api.github.com/orgs/ORG/settings/billing/shared-storage

Response

Status: 200

{
  "days_left_in_billing_cycle": 20,
  "estimated_paid_storage_for_month": 15,
  "estimated_storage_for_month": 40
}

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".

Access tokens must have the user scope.

Parâmetros

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`username`stringObrigatório The handle for the GitHub user account.

HTTP response status codes

Status code	Descrição
`200`	OK

Amostras de código

get/users/{username}/settings/billing/actions

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://api.github.com/users/USERNAME/settings/billing/actions

Response

Status: 200

{
  "total_minutes_used": 305,
  "total_paid_minutes_used": 0,
  "included_minutes": 3000,
  "minutes_used_breakdown": {
    "UBUNTU": 205,
    "MACOS": 10,
    "WINDOWS": 90
  }
}

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."

Access tokens must have the user scope.

Parâmetros

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`username`stringObrigatório The handle for the GitHub user account.

HTTP response status codes

Status code	Descrição
`200`	OK

Amostras de código

get/users/{username}/settings/billing/packages

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://api.github.com/users/USERNAME/settings/billing/packages

Response

Status: 200

{
  "total_gigabytes_bandwidth_used": 50,
  "total_paid_gigabytes_bandwidth_used": 40,
  "included_gigabytes_bandwidth": 10
}

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."

Access tokens must have the user scope.

Parâmetros

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`username`stringObrigatório The handle for the GitHub user account.

HTTP response status codes

Status code	Descrição
`200`	OK

Amostras de código

get/users/{username}/settings/billing/shared-storage

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://api.github.com/users/USERNAME/settings/billing/shared-storage

Response

Status: 200

{
  "days_left_in_billing_cycle": 20,
  "estimated_paid_storage_for_month": 15,
  "estimated_storage_for_month": 40
}