Get Copilot seat information and settings for an organization

GET

/orgs/{org}/copilot/billing

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

Gets information about an organization’s Copilot subscription, including seat breakdown and feature policies. To configure these settings, go to your organization’s settings on GitHub.com. For more information, see “Managing policies for Copilot in your organization.”

Only organization owners can view details about the organization’s Copilot Business or Copilot Enterprise subscription.

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

API method documentation

Parameters

Path Parameters

org

required

string

The organization name. The name is not case sensitive.

Responses

200

OK

Media type application/json

Copilot Organization Details

Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.

object

seat_breakdown

required

Copilot Seat Breakdown

The breakdown of Copilot Business seats for the organization.

object

total

The total number of seats being billed for the organization as of the current billing cycle.

integer

added_this_cycle

Seats added during the current billing cycle.

integer

pending_cancellation

The number of seats that are pending cancellation at the end of the current billing cycle.

integer

pending_invitation

The number of users who have been invited to receive a Copilot seat through this organization.

integer

active_this_cycle

The number of seats that have used Copilot during the current billing cycle.

integer

inactive_this_cycle

The number of seats that have not used Copilot during the current billing cycle.

integer

public_code_suggestions

required

The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).

string

Allowed values: allow block unconfigured

ide_chat

The organization policy for allowing or disallowing Copilot Chat in the IDE.

string

Allowed values: enabled disabled unconfigured

platform_chat

The organization policy for allowing or disallowing Copilot features on GitHub.com.

string

Allowed values: enabled disabled unconfigured

cli

The organization policy for allowing or disallowing Copilot CLI.

string

Allowed values: enabled disabled unconfigured

seat_management_setting

required

The mode of assigning new seats.

string

Allowed values: assign_all assign_selected disabled unconfigured

plan_type

The Copilot plan of the organization, or the parent enterprise, when applicable.

string

Allowed values: business enterprise

key

additional properties

any

Examples

Example default

{
  "seat_breakdown": {
    "total": 12,
    "added_this_cycle": 9,
    "pending_invitation": 0,
    "pending_cancellation": 0,
    "active_this_cycle": 12,
    "inactive_this_cycle": 11
  },
  "seat_management_setting": "assign_selected",
  "ide_chat": "enabled",
  "platform_chat": "enabled",
  "cli": "enabled",
  "public_code_suggestions": "block",
  "plan_type": "business"
}

401

Requires authentication

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

403

Forbidden

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

404

Resource not found

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

422

There is a problem with your account’s associated payment method.

500

Internal Error

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}