Cobrança

Use a API REST para obter informações de cobrança para uma empresa.

Sobre a cobrança

Você pode obter informações de cobrança para uma empresa. Para obter mais informações, confira "Administração do GitHub 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

Cabeçalhos
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github+json` is recommended.
Parâmetros de caminho
Nome, Tipo, Descrição
`org`stringObrigatório The organization name. The name is not case sensitive.

Códigos de status de resposta HTTP

Código de status	Descrição
`200`	OK

Exemplos de código

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

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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 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

Cabeçalhos
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github+json` is recommended.
Parâmetros de caminho
Nome, Tipo, Descrição
`org`stringObrigatório The organization name. The name is not case sensitive.

Códigos de status de resposta HTTP

Código de status	Descrição
`200`	OK

Exemplos de código

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

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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

Cabeçalhos
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github+json` is recommended.
Parâmetros de caminho
Nome, Tipo, Descrição
`org`stringObrigatório The organization name. The name is not case sensitive.

Códigos de status de resposta HTTP

Código de status	Descrição
`200`	OK

Exemplos de código

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

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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

Cabeçalhos
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github+json` is recommended.
Parâmetros de caminho
Nome, Tipo, Descrição
`username`stringObrigatório The handle for the GitHub user account.

Códigos de status de resposta HTTP

Código de status	Descrição
`200`	OK

Exemplos de código

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

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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

Cabeçalhos
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github+json` is recommended.
Parâmetros de caminho
Nome, Tipo, Descrição
`username`stringObrigatório The handle for the GitHub user account.

Códigos de status de resposta HTTP

Código de status	Descrição
`200`	OK

Exemplos de código

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

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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

Cabeçalhos
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github+json` is recommended.
Parâmetros de caminho
Nome, Tipo, Descrição
`username`stringObrigatório The handle for the GitHub user account.

Códigos de status de resposta HTTP

Código de status	Descrição
`200`	OK

Exemplos de código

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

curl \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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
}