provider billing GET /users/{username}/settings/billing/usage
@utdk/github /users/{username}/settings/billing/usage
Get billing usage report for a user
Gets a report of the total usage for a user. **Note:** This endpoint is only available to users with access to the enhanced billing platform.
username path required
The handle for the GitHub user account.
string
year query
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.
integer
month query
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.
integer
day query
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.
integer

Try it

Authentication
Configure credentials for GitHub v3 REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

billing.getGithubBillingUsageReportUser
GET/users/{username}/settings/billing/usage
Gets a report of the total usage for a user. **Note:** This endpoint is only available to users with access to the enhanced billing platform.

Parameters

required

The handle for the GitHub user account.

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.

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.

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.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.billing.getGithubBillingUsageReportUser()