Sample - GitHub REST API
GET/orgs/{org}/copilot/billing

Get Copilot seat information and settings

Retrieves Copilot subscription details for an organization, including its seat breakdown and feature policies. Supply org to identify the organization; only the authenticated user's organization-owner access can view these details. The endpoint is in public preview and may change.

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

1 parameter
orgstringrequired
The organization name whose Copilot subscription details you want to retrieve. The name is not case sensitive.

6 status codes
200Returns an object containing the organization's Copilot seat breakdown, public code suggestion policy, IDE chat policy, platform chat policy, CLI policy, seat management setting, and plan type.
seat_breakdownobjectrequired
The breakdown of Copilot Business seats for the organization.
public_code_suggestionsstringrequired
The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).
Allowed:allowblockunconfigured
ide_chatstringoptional
The organization policy for allowing or disallowing Copilot Chat in the IDE.
Allowed:enableddisabledunconfigured
platform_chatstringoptional
The organization policy for allowing or disallowing Copilot features on GitHub.com.
Allowed:enableddisabledunconfigured
clistringoptional
The organization policy for allowing or disallowing Copilot CLI.
Allowed:enableddisabledunconfigured
seat_management_settingstringrequired
The mode of assigning new seats.
Allowed:assign_allassign_selecteddisabledunconfigured
plan_typestringoptional
The Copilot plan of the organization, or the parent enterprise, when applicable.
Allowed:businessenterprise
401Returned when authentication is missing or invalid.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
403Returned when the authenticated user is not an organization owner.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Returned when the organization cannot be found.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Returned when there is a problem with the account's associated payment method.
500Returned when an internal error occurs.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 401 is returned when authentication is missing or invalid, and a 403 is returned when the authenticated user is not an organization owner. A 404 is returned when the organization cannot be found, a 422 is returned when the account's associated payment method has a problem, and a 500 is returned for an internal error. org must identify an existing organization, and OAuth app tokens or classic personal access tokens must have the manage_billing:copilot or read:org scope.