Skip to main content

org_seats

Overview

Nameorg_seats
TypeResource
Idgithub.copilot.org_seats

Fields

NameDatatypeDescription
seatsarray
total_seatsintegerTotal number of Copilot For Business seats for the organization currently being billed.

Methods

NameAccessible byRequired ParamsDescription
list_copilot_seatsSELECTorgNote: This endpoint is in beta and is subject to change.

Lists all Copilot for Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).

Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must
authenticate using an access token with the manage_billing:copilot scope to use this endpoint.
add_copilot_for_business_seats_for_teamsINSERTorg, data__selected_teamsNote: This endpoint is in beta and is subject to change.

Purchases a GitHub Copilot for Business seat for all users within each specified team.
The organization will be billed accordingly. For more information about Copilot for Business pricing, see "About billing for GitHub Copilot for Business".

Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must
authenticate using an access token with the manage_billing:copilot scope to use this endpoint.

In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy.
For more information about setting up a Copilot for Business subscription, see "Setting up a Copilot for Business subscription for your organization".
For more information about setting a suggestion matching policy, see "Configuring suggestion matching policies for GitHub Copilot in your organization".
cancel_copilot_seat_assignment_for_teamsEXECorg, data__selected_teamsNote: This endpoint is in beta and is subject to change.

Cancels the Copilot for Business seat assignment for all members of each team specified.
This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.

For more information about Copilot for Business pricing, see "About billing for GitHub Copilot for Business".

For more information about disabling access to Copilot for Business, see "Disabling access to GitHub Copilot for specific users in your organization".

Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must
authenticate using an access token with the manage_billing:copilot scope to use this endpoint.