copilot

Remove enterprise teams from the Copilot subscription for an enterprise

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

Sets seats for all members of each enterprise team specified to "pending cancellation". This will cause the members of the specified enterprise team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another enterprise team.

Only enterprise owners can cancel Copilot seats for their enterprise members.

The response contains the total number of seats set to "pending cancellation".

OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot or admin:enterprise scopes to use this endpoint.

delete/enterprises/{enterprise}/copilot/billing/selected_enterprise_teams

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/enterprises/{enterprise}/copilot/billing/selected_enterprise_teams
  • Auth: none declared

Path parameters

enterprisestring required

The slug version of the enterprise name.

Request body

selected_enterprise_teamsstring[] required

List of enterprise team names within the enterprise to which to grant access to GitHub Copilot.

Response

OK

seats_cancelledinteger required

Changes

No recorded changes to this operation across all 83 revisions of this API.