Get billing premium request usage report for a user

GET

/users/{username}/settings/billing/premium_request/usage

Gets a report of premium request usage for a user.

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

API method documentation

Parameters

Path Parameters

username

required

string

The handle for the GitHub user account.

Query Parameters

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.

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.

Responses

200

Response when getting a billing premium request usage report

Media type application/json

object

timePeriod

required

object

year

required

The year for the usage report.

integer

month

The month for the usage report.

integer

day

The day for the usage report.

integer

user

required

The unique identifier of the user.

string

product

The product for the usage report.

string

model

The model for the usage report.

string

usageItems

required

Array<object>

object

product

required

Product name.

string

sku

required

SKU name.

string

model

required

Model name.

string

unitType

required

Unit type of the usage line item.

string

pricePerUnit

required

Price per unit of the usage line item.

number

grossQuantity

required

Gross quantity of the usage line item.

number

grossAmount

required

Gross amount of the usage line item.

number

discountQuantity

required

Discount quantity of the usage line item.

number

discountAmount

required

Discount amount of the usage line item.

number

netQuantity

required

Net quantity of the usage line item.

number

netAmount

required

Net amount of the usage line item.

number

Examples

Example default

{
  "timePeriod": {
    "year": 2025
  },
  "user": "monalisa",
  "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
    }
  ]
}

400

Bad Request

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

Scim Error

Scim Error

object

message

string

nullable

documentation_url

string

nullable

detail

string

nullable

status

integer

scimType

string

nullable

schemas

Array<string>

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "detail": "example",
  "status": 1,
  "scimType": "example",
  "schemas": [
    "example"
  ]
}

403

Forbidden

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

500

Internal Error

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

503

Service unavailable

Media type application/json

object

code

string

message

string

documentation_url

string

Example ^generated

{
  "code": "example",
  "message": "example",
  "documentation_url": "example"
}