provider billing GET /users/{username}/settings/billing/usage/summary
@utdk/github /users/{username}/settings/billing/usage/summary
Get billing usage summary for a user
> [!NOTE] > This endpoint is in public preview and is subject to change. Gets a summary report of usage for a user. **Note:** Only data from the past 24 months is accessible via this endpoint.
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`. Default value is the current month. 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
repository query
The repository name to query for usage in the format owner/repository.
string
product query
The product name to query usage for. The name is not case sensitive.
string
sku query
The SKU to query for usage.
string

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.getGithubBillingUsageSummaryReportUser
GET/users/{username}/settings/billing/usage/summary
> [!NOTE] > This endpoint is in public preview and is subject to change. Gets a summary report of usage for a user. **Note:** Only data from the past 24 months is accessible via this endpoint.

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`. Default value is the current month. 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.

The repository name to query for usage in the format owner/repository.

The product name to query usage for. The name is not case sensitive.

The SKU to query for usage.

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.getGithubBillingUsageSummaryReportUser()