Использование выставления счетов

Get billing premium request usage report for an enterprise

Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.

Note: Only data from the past 24 months is accessible via this endpoint.

Подробные маркеры доступа для "Get billing premium request usage report for an enterprise

Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.

Параметры для "Get billing premium request usage report for an enterprise"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`enterprise` string Обязательное поле The slug version of the enterprise name.

Параметры запроса
Имя., Тип, Description
`year` integer If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.
`month` integer If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used.
`day` integer If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.
`organization` string The organization name to query usage for. The name is not case sensitive.
`user` string The user name to query usage for. The name is not case sensitive.
`model` string The model name to query usage for. The name is not case sensitive.
`product` string The product name to query usage for. The name is not case sensitive.
`cost_center_id` string The ID corresponding to a cost center. An ID of 'none' will target usage not associated to any cost center.

Коды состояния http-ответа для "Get billing premium request usage report for an enterprise"

Код состояния	Description
`200`	Response when getting a billing premium request usage report
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error
`503`	Service unavailable

Примеры кода для "Get billing premium request usage report for an enterprise"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

get/enterprises/{enterprise}/settings/billing/premium_request/usage

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/premium_request/usage

Response when getting a billing premium request usage report

Status: 200

{
  "timePeriod": {
    "year": 2025
  },
  "enterprise": "GitHub",
  "usageItems": [
    {
      "product": "Copilot",
      "sku": "Copilot Premium Request",
      "model": "GPT-5",
      "unitType": "requests",
      "pricePerUnit": 0.04,
      "grossQuantity": 100,
      "grossAmount": 4,
      "discountQuantity": 0,
      "discountAmount": 0,
      "netQuantity": 100,
      "netAmount": 4
    }
  ]
}

Get billing usage report for an enterprise

Gets a report of usage by cost center for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default this endpoint will return usage that does not have a cost center.

Note: This endpoint is only available to enterprises with access to the enhanced billing platform. For more information, see "About the enhanced billing platform for enterprises."

Подробные маркеры доступа для "Get billing usage report for an enterprise

Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.

Параметры для "Get billing usage report for an enterprise"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`enterprise` string Обязательное поле The slug version of the enterprise name.

Параметры запроса
Имя., Тип, Description
`year` integer If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.
`month` integer If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used.
`day` integer If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.
`cost_center_id` string The ID corresponding to a cost center. The default value is no cost center.

Коды состояния http-ответа для "Get billing usage report for an enterprise"

Код состояния	Description
`200`	Response when getting a billing usage report
`400`	Bad Request
`403`	Forbidden
`500`	Internal Error
`503`	Service unavailable

Примеры кода для "Get billing usage report for an enterprise"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

get/enterprises/{enterprise}/settings/billing/usage

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/usage

Response when getting a billing usage report

Status: 200

{
  "usageItems": [
    {
      "date": "2023-08-01",
      "product": "Actions",
      "sku": "Actions Linux",
      "quantity": 100,
      "unitType": "minutes",
      "pricePerUnit": 0.008,
      "grossAmount": 0.8,
      "discountAmount": 0,
      "netAmount": 0.8,
      "organizationName": "GitHub",
      "repositoryName": "github/example"
    }
  ]
}

Get billing usage summary for an enterprise

Note

This endpoint is in public preview and is subject to change.

Gets a summary report of usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. By default, this endpoint will return usage across all cost centers in the enterprise.

Note: Only data from the past 24 months is accessible via this endpoint.

Подробные маркеры доступа для "Get billing usage summary for an enterprise

Эта конечная точка не работает с маркерами доступа пользователей приложения GitHub, маркерами доступа к установке приложения GitHub или точными личными маркерами доступа.

Параметры для "Get billing usage summary for an enterprise"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`enterprise` string Обязательное поле The slug version of the enterprise name.

Параметры запроса
Имя., Тип, Description
`year` integer If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year.
`month` integer If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used.
`day` integer If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used.
`organization` string The organization name to query usage for. The name is not case sensitive.
`repository` string The repository name to query for usage in the format owner/repository.
`product` string The product name to query usage for. The name is not case sensitive.
`sku` string The SKU to query for usage.
`cost_center_id` string The ID corresponding to a cost center. An ID of 'none' will target usage not associated to any cost center.

Коды состояния http-ответа для "Get billing usage summary for an enterprise"

Код состояния	Description
`200`	Response when getting a billing usage summary
`400`	Bad Request
`403`	Forbidden
`500`	Internal Error
`503`	Service unavailable

Примеры кода для "Get billing usage summary for an enterprise"

Если вы обращаетесь к GitHub в GHE.com, замените api.github.com выделенный поддомен api.SUBDOMAIN.ghe.comпредприятия.

Пример запроса

get/enterprises/{enterprise}/settings/billing/usage/summary

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/usage/summary

Response when getting a billing usage summary

Status: 200

{
  "timePeriod": {
    "year": 2025
  },
  "enterprise": "GitHub",
  "usageItems": [
    {
      "product": "Actions",
      "sku": "actions_linux",
      "unitType": "minutes",
      "pricePerUnit": 0.008,
      "grossQuantity": 1000,
      "grossAmount": 8,
      "discountQuantity": 0,
      "discountAmount": 0,
      "netQuantity": 1000,
      "netAmount": 8
    }
  ]
}