Billing

Download Spec

Monitor charges and usage from Actions and Packages.

Get GitHub Advanced Security active committers for an enterprise

get /enterprises/{enterprise}/settings/billing/advanced-security

Gets the GitHub Advanced Security active committers for an enterprise per repository.

Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of active_users for each repository.

The total number of repositories with committer information is tracked by the total_count field.

enterprise

string

required

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

per_page

int

The number of results per page (max 100).

Default
30

page

int

Page number of the results to fetch.

Default
1

Response

Examples Schema

Success

{
  "total_advanced_security_committers": 2,
  "total_count": 2,
  "repositories": [
    {
      "name": "octocat-org/Hello-World",
      "advanced_security_committers": 2,
      "advanced_security_committers_breakdown": [
        {
          "user_login": "octocat",
          "last_pushed_date": "2021-11-03"
        },
        {
          "user_login": "octokitten",
          "last_pushed_date": "2021-10-25"
        }
      ]
    },
    {
      "name": "octocat-org/server",
      "advanced_security_committers": 1,
      "advanced_security_committers_breakdown": [
        {
          "user_login": "octokitten",
          "last_pushed_date": "2021-10-26"
        }
      ]
    }
  ]
}

Response if GitHub Advanced Security is not enabled for this repository

{
  "message": "string",
  "documentation_url": "string",
  "url": "string",
  "status": "string"
}

total_advanced_security_committers

int

Example
25

total_count

int

Example
2

repositories

array[object]

required

object

name

string

required

Example
"octocat/Hello-World"

advanced_security_committers

int

required

Example
25

advanced_security_committers_breakdown

array[object]

required

object

user_login

string

required

last_pushed_date

string

required

Example
"2021-11-03"

message

string

documentation_url

string

url

string

status

string

Get GitHub Advanced Security active committers for an organization

get /orgs/{org}/settings/billing/advanced-security

Gets the GitHub Advanced Security active committers for an organization per repository.

Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers is not the sum of advanced_security_committers for each repository.

If this organization defers to an enterprise for billing, the total_advanced_security_committers returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level.

The total number of repositories with committer information is tracked by the total_count field.

org

string

required

The organization name. The name is not case sensitive.

per_page

int

The number of results per page (max 100).

Default
30

page

int

Page number of the results to fetch.

Default
1

Response

Examples Schema

Success

{
  "total_advanced_security_committers": 2,
  "total_count": 2,
  "repositories": [
    {
      "name": "octocat-org/Hello-World",
      "advanced_security_committers": 2,
      "advanced_security_committers_breakdown": [
        {
          "user_login": "octocat",
          "last_pushed_date": "2021-11-03"
        },
        {
          "user_login": "octokitten",
          "last_pushed_date": "2021-10-25"
        }
      ]
    },
    {
      "name": "octocat-org/server",
      "advanced_security_committers": 1,
      "advanced_security_committers_breakdown": [
        {
          "user_login": "octokitten",
          "last_pushed_date": "2021-10-26"
        }
      ]
    }
  ]
}

Response if GitHub Advanced Security is not enabled for this repository

{
  "message": "string",
  "documentation_url": "string",
  "url": "string",
  "status": "string"
}

total_advanced_security_committers

int

Example
25

total_count

int

Example
2

repositories

array[object]

required

object

name

string

required

Example
"octocat/Hello-World"

advanced_security_committers

int

required

Example
25

advanced_security_committers_breakdown

array[object]

required

object

user_login

string

required

last_pushed_date

string

required

Example
"2021-11-03"

message

string

documentation_url

string

url

string

status

string

Was this page helpful?