Get billing usage summary for an organization

GET

/organizations/{org}/settings/billing/usage/summary

[!NOTE] This endpoint is in public preview and is subject to change.

Gets a summary report of usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.

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

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

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.

repository

string

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

product

string

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

sku

string

The SKU to query for usage.

Responses

200

Response when getting a billing usage summary

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

organization

required

The unique identifier of the organization.

string

repository

The name of the repository for the usage report.

string

product

The product for the usage report.

string

sku

The SKU for the usage report.

string

usageItems

required

Array<object>

object

product

required

Product name.

string

sku

required

SKU 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
  },
  "organization": "GitHub",
  "usageItems": [
    {
      "product": "Actions",
      "sku": "actions_linux",
      "unitType": "minutes",
      "pricePerUnit": 0.008,
      "grossQuantity": 1000,
      "grossAmount": 8,
      "discountQuantity": 0,
      "discountAmount": 0,
      "netQuantity": 1000,
      "netAmount": 8
    }
  ]
}

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"
}

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"
}