Skip to main content

ai_credit_usage

Creates, updates, deletes, gets or lists an ai_credit_usage resource.

Overview

Nameai_credit_usage
TypeResource
Idgithub.billing.ai_credit_usage

Fields

The following fields are returned by SELECT queries:

Response when getting a billing AI credit usage report

NameDatatypeDescription
discountAmountnumberDiscount amount of the usage line item.
discountQuantitynumberDiscount quantity of the usage line item.
grossAmountnumberGross amount of the usage line item.
grossQuantitynumberGross quantity of the usage line item.
modelstringModel name.
netAmountnumberNet amount of the usage line item.
netQuantitynumberNet quantity of the usage line item.
pricePerUnitnumberPrice per unit of the usage line item.
productstringProduct name.
skustringSKU name.
unitTypestringUnit type of the usage line item.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_github_billing_ai_credit_usage_report_userselectusernameyear, month, day, model, productGets a report of AI credit usage for a user.

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

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
usernamestringThe handle for the GitHub user account.
dayintegerIf 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.
modelstringThe model name to query usage for. The name is not case sensitive.
monthintegerIf 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.
productstringThe product name to query usage for. The name is not case sensitive.
yearintegerIf 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.

SELECT examples

Gets a report of AI credit usage for a user.

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

SELECT
discountAmount,
discountQuantity,
grossAmount,
grossQuantity,
model,
netAmount,
netQuantity,
pricePerUnit,
product,
sku,
unitType
FROM github.billing.ai_credit_usage
WHERE username = '{{ username }}' -- required
AND year = '{{ year }}'
AND month = '{{ month }}'
AND day = '{{ day }}'
AND model = '{{ model }}'
AND product = '{{ product }}'
;