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

Add users to an organization's Copilot subscription

Creates Copilot seats for each user specified for an organization. Use selected_usernames to identify the organization members who should receive access, and ensure the organization has a Copilot Business or Copilot Enterprise subscription with a configured suggestion matching policy. The response reports the number of newly created and refreshed seats.

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

1 parameter · 1 body field
orgstringrequired
The organization name whose Copilot subscription you want to manage; the name is not case sensitive.

The organization members to grant access to GitHub Copilot.

selected_usernamesarray<string>required
The usernames of the organization members to be granted access to GitHub Copilot.

6 status codes
201Returns an object containing `seats_created`, the total number of new seats created for the specified users and existing seats refreshed.
seats_createdintegerrequired
401Returned when authentication is missing or invalid.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
403Returned when the authenticated caller is not an organization owner or lacks the required Copilot billing or organization administration scope.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
404Returned when the organization or another specified resource cannot be found.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional
422Returned when Copilot Business or Enterprise is not enabled, billing or the public code suggestions policy is not configured, or the organization's Copilot access setting is invalid or unconfigured.
500Returned when an internal server error occurs.
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 401 is returned when authentication is missing or invalid. A 403 is returned when you are not an organization owner or your token lacks the manage_billing:copilot or admin:org scope. A 404 is returned when the organization or specified resource cannot be found. A 422 is returned when Copilot Business or Enterprise, billing, the public code suggestions policy, or a valid Copilot access setting is not configured. A 500 is returned for an internal server error. selected_usernames must contain at least one username, and org must identify the target organization.