# 使用情况计费

使用 REST API 获取计费使用情况信息。

此页面上的终结点将返回与终结点关联的帐户将计费的使用情况。 有关确定要报告的使用情况级别的帮助，请参阅 [使用 REST API 自动报告使用情况](/zh/enterprise-cloud@latest/billing/tutorials/automate-usage-reporting#step-1-decide-what-level-to-report-on)。

* 用户终结点将返回直接计费到各个用户的个人帐户的 Copilot 使用情况。 仅当用户购买了自己的 Copilot 计划时，这些端点才适用。
* 如果通过组织或企业对用户的 Copilot 许可证进行管理和计费，则用户级终结点中不会包括其使用情况。 在这种情况下，必须改用组织或企业级终结点。

若要查看用户和组织级别的终端，请选择页面顶部的下拉菜单，然后从 GitHub Enterprise Cloud 切换到“Free”、“Pro”和“Team”。

> \[!NOTE]
> Most endpoints use `Authorization: Bearer <YOUR-TOKEN>` and `Accept: application/vnd.github+json` headers, plus `X-GitHub-Api-Version: 2022-11-28`. Curl examples below omit these standard headers for brevity.

## Get billing AI credit usage report for an enterprise

```
GET /enterprises/{enterprise}/settings/billing/ai_credit/usage
```

Gets a report of AI credit 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.

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`enterprise`** (string) (required)
  The slug version of the enterprise name.

* **`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 response status codes

* **200** - Response when getting a billing AI credit usage report

* **400** - Bad Request

* **403** - Forbidden

* **404** - Resource not found

* **500** - Internal Error

* **503** - Service unavailable

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/ai_credit/usage
```

**Response schema (Status: 200):**

* `timePeriod`: required, object:
  * `year`: required, integer
  * `month`: integer
  * `day`: integer
* `enterprise`: required, string
* `user`: string
* `organization`: string
* `product`: string
* `model`: string
* `costCenter`: object:
  * `id`: required, string
  * `name`: required, string
* `usageItems`: required, array of objects:
  * `product`: required, string
  * `sku`: required, string
  * `model`: required, string
  * `unitType`: required, string
  * `pricePerUnit`: required, number
  * `grossQuantity`: required, number
  * `grossAmount`: required, number
  * `discountQuantity`: required, number
  * `discountAmount`: required, number
  * `netQuantity`: required, number
  * `netAmount`: required, number

## Get billing premium request usage report for an enterprise

```
GET /enterprises/{enterprise}/settings/billing/premium_request/usage
```

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.

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`enterprise`** (string) (required)
  The slug version of the enterprise name.

* **`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 response status codes

* **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

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/premium_request/usage
```

**Response schema (Status: 200):**

Same response schema as [Get billing AI credit usage report for an enterprise](#get-billing-ai-credit-usage-report-for-an-enterprise).

## Get billing usage report for an enterprise

```
GET /enterprises/{enterprise}/settings/billing/usage
```

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

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`enterprise`** (string) (required)
  The slug version of the enterprise name.

* **`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 response status codes

* **200** - Response when getting a billing usage report

* **400** - Bad Request

* **403** - Forbidden

* **500** - Internal Error

* **503** - Service unavailable

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/usage
```

**Response schema (Status: 200):**

* `usageItems`: array of objects:
  * `date`: required, string
  * `product`: required, string
  * `sku`: required, string
  * `quantity`: required, integer
  * `unitType`: required, string
  * `pricePerUnit`: required, number
  * `grossAmount`: required, number
  * `discountAmount`: required, number
  * `netAmount`: required, number
  * `organizationName`: required, string
  * `repositoryName`: string

## Get billing usage summary for an enterprise

```
GET /enterprises/{enterprise}/settings/billing/usage/summary
```

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.

### Parameters

#### Headers

* **`accept`** (string)
  Setting to `application/vnd.github+json` is recommended.

#### Path and query parameters

* **`enterprise`** (string) (required)
  The slug version of the enterprise name.

* **`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 response status codes

* **200** - Response when getting a billing usage summary

* **400** - Bad Request

* **403** - Forbidden

* **500** - Internal Error

* **503** - Service unavailable

### Code examples

#### Example

**Request:**

```curl
curl -L \
  -X GET \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/usage/summary
```

**Response schema (Status: 200):**

* `timePeriod`: required, object:
  * `year`: required, integer
  * `month`: integer
  * `day`: integer
* `enterprise`: required, string
* `organization`: string
* `repository`: string
* `product`: string
* `sku`: string
* `costCenter`: object:
  * `id`: required, string
  * `name`: required, string
* `usageItems`: required, array of objects:
  * `product`: required, string
  * `sku`: required, string
  * `unitType`: required, string
  * `pricePerUnit`: required, number
  * `grossQuantity`: required, number
  * `grossAmount`: required, number
  * `discountQuantity`: required, number
  * `discountAmount`: required, number
  * `netQuantity`: required, number
  * `netAmount`: required, number