Sample - GitHub REST API
GET/users/{username}/settings/billing/ai_credit/usage

Get billing AI credit usage report for a user

Gets a report of AI credit usage for a user.

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

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

6 parameters
usernamestringrequired
The handle for the GitHub user account.
yearintegeroptional
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.
monthintegeroptional
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.
dayintegeroptional
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.
modelstringoptional
The model name to query usage for. The name is not case sensitive.
productstringoptional
The product name to query usage for. The name is not case sensitive.

6 status codes
200Response when getting a billing AI credit usage report
timePeriodobjectrequired
userstringrequired
The unique identifier of the user.
productstringoptional
The product for the usage report.
modelstringoptional
The model for the usage report.
usageItemsarray<object>required
400Bad Request
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
403Forbidden
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
500Internal Error
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
503Service unavailable
codestringoptional
messagestringoptional
documentation_urlstringoptional

Error handling

A 400 is returned: Bad Request. A 403 is returned: Forbidden. A 404 is returned: Resource not found. A 500 is returned: Internal Error. A 503 is returned: Service unavailable.

Was this helpful?