Puntos de conexión de API de REST para facturación de empresa

Get GitHub Actions billing for an enterprise

Gets the summary of the free and paid GitHub Actions minutes used.

Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "Managing billing for GitHub Actions".

The authenticated user must be an enterprise admin.

Note

This endpoint is available to enterprise customers who are using the legacy billing platform.

Tokens de acceso específicos para "Get GitHub Actions billing for an enterprise"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Enterprise administration" enterprise permissions (write)

Parámetros para "Get GitHub Actions billing for an enterprise"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.

Códigos de estado de respuesta HTTP para "Get GitHub Actions billing for an enterprise"

status code	Descripción
`200`	OK

Ejemplos de código para "Get GitHub Actions billing for an enterprise"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/enterprises/{enterprise}/settings/billing/actions

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/actions

Response

Status: 200

{
  "total_minutes_used": 305,
  "total_paid_minutes_used": 0,
  "included_minutes": 3000,
  "minutes_used_breakdown": {
    "UBUNTU": 205,
    "MACOS": 10,
    "WINDOWS": 90
  }
}

Get GitHub Advanced Security active committers for an enterprise

Gets the GitHub Advanced Security active committers for an enterprise per repository. The authenticated user must be an enterprise admin or billing manager.

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.

Tokens de acceso específicos para "Get GitHub Advanced Security active committers for an enterprise"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Enterprise administration" enterprise permissions (write)

Parámetros para "Get GitHub Advanced Security active committers for an enterprise"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.

Parámetros de consulta
Nombre, Tipo, Descripción
`advanced_security_product` string The security product to get GitHub Advanced Security active committers for. For standalone Code Scanning or Secret Protection products, this parameter is required to specify which product you want committer information for. For other plans this parameter cannot be used. Puede ser uno de los siguientes: `code_security`, `secret_protection`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Valor predeterminado: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: `1`

Códigos de estado de respuesta HTTP para "Get GitHub Advanced Security active committers for an enterprise"

status code	Descripción
`200`	Success

Ejemplos de código para "Get GitHub Advanced Security active committers for an enterprise"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/advanced-security

Success

Status: 200

{
  "total_advanced_security_committers": 2,
  "total_count": 2,
  "maximum_advanced_security_committers": 4,
  "purchased_advanced_security_committers": 4,
  "repositories": [
    {
      "name": "octocat-org/Hello-World",
      "advanced_security_committers": 2,
      "advanced_security_committers_breakdown": [
        {
          "user_login": "octocat",
          "last_pushed_date": "2021-11-03",
          "last_pushed_email": "octocat@github.com"
        },
        {
          "user_login": "octokitten",
          "last_pushed_date": "2021-10-25",
          "last_pushed_email": "octokitten@github.com"
        }
      ]
    },
    {
      "name": "octocat-org/server",
      "advanced_security_committers": 1,
      "advanced_security_committers_breakdown": [
        {
          "user_login": "octokitten",
          "last_pushed_date": "2021-10-26",
          "last_pushed_email": "octokitten@github.com"
        }
      ]
    }
  ]
}

Get all cost centers for an enterprise

Gets a list of all the cost centers for an enterprise.

Tokens de acceso específicos para "Get all cost centers for an enterprise"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Get all cost centers for an enterprise"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.

Parámetros de consulta
Nombre, Tipo, Descripción
`state` string Set to `active` or `deleted` to only list cost centers in a specific state. Puede ser uno de los siguientes: `active`, `deleted`

Códigos de estado de respuesta HTTP para "Get all cost centers for an enterprise"

status code	Descripción
`200`	Response when getting cost centers
`400`	Bad Request
`403`	Forbidden
`500`	Internal Error
`503`	Service unavailable

Ejemplos de código para "Get all cost centers for an enterprise"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/enterprises/{enterprise}/settings/billing/cost-centers

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/cost-centers

Response when getting cost centers

Status: 200

{
  "costCenters": [
    {
      "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002",
      "name": "Cost Center Name",
      "state": "active",
      "azure_subscription": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "resources": [
        {
          "type": "User",
          "name": "Monalisa"
        },
        {
          "type": "Repo",
          "name": "octocat/hello-world"
        }
      ]
    },
    {
      "id": "3ffb9ffe-6903-11ee-8c99-0242ac120003",
      "name": "Another Cost Center",
      "state": "active",
      "resources": [
        {
          "type": "User",
          "name": "Octocat"
        }
      ]
    }
  ]
}

Create a new cost center

Creates a new cost center for an enterprise. The authenticated user must be an enterprise admin.

Tokens de acceso específicos para "Create a new cost center"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Create a new cost center"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`name` string Requerido The name of the cost center (max length 255 characters)

Códigos de estado de respuesta HTTP para "Create a new cost center"

status code	Descripción
`200`	Cost center created successfully
`400`	Bad request
`409`	Conflict
`500`	Internal server error

Ejemplos de código para "Create a new cost center"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

post/enterprises/{enterprise}/settings/billing/cost-centers

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/cost-centers \
  -d '{"name":"Engineering Team"}'

Example response for a created cost center

Status: 200

{
  "id": "abc123",
  "name": "Engineering Team",
  "resources": []
}

Get a cost center by ID

Gets a cost center by ID. The authenticated user must be an enterprise admin.

Tokens de acceso específicos para "Get a cost center by ID"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Get a cost center by ID"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.
`cost_center_id` string Requerido The ID corresponding to the cost center.

Códigos de estado de respuesta HTTP para "Get a cost center by ID"

status code	Descripción
`200`	Response when getting a cost center
`400`	Bad Request
`403`	Forbidden
`500`	Internal Error
`503`	Service unavailable

Ejemplos de código para "Get a cost center by ID"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/cost-centers/COST_CENTER_ID

Response when getting a cost center

Status: 200

{
  "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002",
  "name": "Cost Center Name",
  "state": "active",
  "azure_subscription": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "resources": [
    {
      "type": "User",
      "name": "Monalisa"
    },
    {
      "type": "Repo",
      "name": "octocat/hello-world"
    }
  ]
}

Update a cost center name

Updates an existing cost center name.

Tokens de acceso específicos para "Update a cost center name"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Update a cost center name"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name
`cost_center_id` string Requerido The unique identifier of the cost center

Parámetros del cuerpo
Nombre, Tipo, Descripción
`name` string Requerido The new name for the cost center

Códigos de estado de respuesta HTTP para "Update a cost center name"

status code	Descripción
`200`	Response when updating a cost center
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`409`	Conflict
`500`	Internal Error
`503`	Service unavailable

Ejemplos de código para "Update a cost center name"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

patch/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/cost-centers/COST_CENTER_ID \
  -d '{"name":"New Cost Center Name"}'

Response when updating a cost center

Status: 200

{
  "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002",
  "name": "Cost Center Name",
  "state": "active",
  "azure_subscription": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
  "resources": [
    {
      "type": "User",
      "name": "Monalisa"
    },
    {
      "type": "Repo",
      "name": "octocat/hello-world"
    }
  ]
}

Delete a cost center

Archieves a cost center by ID. The authenticated user must be an enterprise admin.

Tokens de acceso específicos para "Delete a cost center"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Delete a cost center"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.
`cost_center_id` string Requerido The ID corresponding to the cost center.

Códigos de estado de respuesta HTTP para "Delete a cost center"

status code	Descripción
`200`	Response when deleting a cost center
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error
`503`	Service unavailable

Ejemplos de código para "Delete a cost center"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

delete/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/cost-centers/COST_CENTER_ID

Response when deleting a cost center

Status: 200

{
  "message": "Cost center successfully deleted.",
  "id": "2066deda-923f-43f9-88d2-62395a28c0cdd",
  "name": "cc3",
  "costCenterState": "CostCenterArchived"
}

Add resources to a cost center

Adds resources to a cost center.

The usage for the resources will be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint.

Tokens de acceso específicos para "Add resources to a cost center"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Add resources to a cost center"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.
`cost_center_id` string Requerido The ID corresponding to the cost center.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`users` array of strings The usernames of the users to add to the cost center.
`organizations` array of strings The organizations to add to the cost center.
`repositories` array of strings The repositories to add to the cost center.

Códigos de estado de respuesta HTTP para "Add resources to a cost center"

status code	Descripción
`200`	Response when adding resources to a cost center
`400`	Bad Request
`403`	Forbidden
`409`	Conflict
`500`	Internal Error
`503`	Service unavailable

Ejemplos de código para "Add resources to a cost center"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

post/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}/resource

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/cost-centers/COST_CENTER_ID/resource \
  -d '{"users":["monalisa"]}'

Response when adding resources to a cost center

Status: 200

{
  "message": "Resources successfully added to the cost center.",
  "reassigned_resources": [
    {
      "resource_type": "user",
      "name": "monalisa",
      "previous_cost_center": "old-cost-center"
    },
    {
      "resource_type": "organization",
      "name": "octo-org",
      "previous_cost_center": "another-cost-center"
    },
    {
      "resource_type": "repository",
      "name": "octo-repo",
      "previous_cost_center": "yet-another-cost-center"
    }
  ]
}

Remove resources from a cost center

Remove resources from a cost center.

The usage for the resources will no longer be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint.

Tokens de acceso específicos para "Remove resources from a cost center"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Remove resources from a cost center"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.
`cost_center_id` string Requerido The ID corresponding to the cost center.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`users` array of strings The usernames of the users to remove from the cost center.
`organizations` array of strings The organizations to remove from the cost center.
`repositories` array of strings The repositories to remove from the cost center.

Códigos de estado de respuesta HTTP para "Remove resources from a cost center"

status code	Descripción
`200`	Response when removing resources from a cost center
`400`	Bad Request
`403`	Forbidden
`500`	Internal Error
`503`	Service unavailable

Ejemplos de código para "Remove resources from a cost center"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

delete/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}/resource

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/cost-centers/COST_CENTER_ID/resource \
  -d '{"users":["monalisa"]}'

Response when removing resources from a cost center

Status: 200

{
  "message": "Resources successfully removed from the cost center."
}

Get GitHub Packages billing for an enterprise

Gets the free and paid storage used for GitHub Packages in gigabytes.

Paid minutes only apply to packages stored for private repositories. For more information, see "Managing billing for GitHub Packages."

The authenticated user must be an enterprise admin.

Note

This endpoint is available to enterprise customers who are using the legacy billing platform.

Tokens de acceso específicos para "Get GitHub Packages billing for an enterprise"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Enterprise administration" enterprise permissions (write)

Parámetros para "Get GitHub Packages billing for an enterprise"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.

Códigos de estado de respuesta HTTP para "Get GitHub Packages billing for an enterprise"

status code	Descripción
`200`	OK

Ejemplos de código para "Get GitHub Packages billing for an enterprise"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/enterprises/{enterprise}/settings/billing/packages

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/packages

Response

Status: 200

{
  "total_gigabytes_bandwidth_used": 50,
  "total_paid_gigabytes_bandwidth_used": 40,
  "included_gigabytes_bandwidth": 10
}

Get billing premium request usage report for an enterprise

Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.

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

Tokens de acceso específicos para "Get billing premium request usage report for an enterprise"

Este punto de conexión no funciona con tokens de acceso de usuario de aplicación de GitHub, tokens de acceso de instalación de aplicaciones de GitHub ni tokens de acceso personales específicos.

Parámetros para "Get billing premium request usage report for an enterprise"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.

Parámetros de consulta
Nombre, Tipo, Descripción
`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.
`organization` string The organization name to query usage for. The name is not case sensitive.
`user` string The user name to query usage for. The name is not case sensitive.
`model` string The model name to query usage for. The name is not case sensitive.
`product` string The product name to query usage for. The name is not case sensitive.
`cost_center_id` string The ID corresponding to a cost center. An ID of 'none' will target usage not associated to any cost center.

Códigos de estado de respuesta HTTP para "Get billing premium request usage report for an enterprise"

status code	Descripción
`200`	Response when getting a billing premium request usage report
`400`	Bad Request
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error
`503`	Service unavailable

Ejemplos de código para "Get billing premium request usage report for an enterprise"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/enterprises/{enterprise}/settings/billing/premium_request/usage

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/premium_request/usage

Response when getting a billing premium request usage report

Status: 200

{
  "timePeriod": {
    "year": 2025
  },
  "enterprise": "GitHub",
  "usageItems": [
    {
      "product": "Copilot",
      "sku": "Copilot Premium Request",
      "model": "GPT-5",
      "unitType": "requests",
      "pricePerUnit": 0.04,
      "grossQuantity": 100,
      "grossAmount": 4,
      "discountQuantity": 0,
      "discountAmount": 0,
      "netQuantity": 100,
      "netAmount": 4
    }
  ]
}

Get shared storage billing for an enterprise

Gets the estimated paid and estimated total storage used for GitHub Actions and GitHub Packages.

Paid minutes only apply to packages stored for private repositories. For more information, see "Managing billing for GitHub Packages."

The authenticated user must be an enterprise admin.

Note

This endpoint is available to enterprise customers who are using the legacy billing platform.

Tokens de acceso específicos para "Get shared storage billing for an enterprise"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Enterprise administration" enterprise permissions (write)

Parámetros para "Get shared storage billing for an enterprise"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.

Códigos de estado de respuesta HTTP para "Get shared storage billing for an enterprise"

status code	Descripción
`200`	OK

Ejemplos de código para "Get shared storage billing for an enterprise"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/enterprises/{enterprise}/settings/billing/shared-storage

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/shared-storage

Response

Status: 200

{
  "days_left_in_billing_cycle": 20,
  "estimated_paid_storage_for_month": 15,
  "estimated_storage_for_month": 40
}

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.

Parámetros de consulta
Nombre, Tipo, Descripción
`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`. 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.
`hour` integer If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. If no `year`, `month`, or `day` is specified, the default `year`, `month`, and `day` are used.
`cost_center_id` string The ID corresponding to a cost center. The default value is no cost center.

Códigos de estado de respuesta HTTP para "Get billing usage report for an enterprise"

status code	Descripción
`200`	Response when getting a billing usage report
`400`	Bad Request
`403`	Forbidden
`500`	Internal Error
`503`	Service unavailable

Ejemplos de código para "Get billing usage report for an enterprise"

Si accedes a GitHub en GHE.com, reemplaza api.github.com por el subdominio dedicado de la empresa en api.SUBDOMAIN.ghe.com.

Ejemplo de solicitud

get/enterprises/{enterprise}/settings/billing/usage

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/enterprises/ENTERPRISE/settings/billing/usage

Response when getting a billing usage report

Status: 200

{
  "usageItems": [
    {
      "date": "2023-08-01",
      "product": "Actions",
      "sku": "Actions Linux",
      "quantity": 100,
      "unitType": "minutes",
      "pricePerUnit": 0.008,
      "grossAmount": 0.8,
      "discountAmount": 0,
      "netAmount": 0.8,
      "organizationName": "GitHub",
      "repositoryName": "github/example"
    }
  ]
}