Struct CopilotUserResponse 

pub struct CopilotUserResponse {

    pub access_type_sku: Option<String>,
    pub analytics_tracking_id: Option<String>,
    pub assigned_date: Option<Value>,
    pub can_signup_for_limited: Option<bool>,
    pub can_upgrade_plan: Option<bool>,
    pub chat_enabled: Option<bool>,
    pub cli_remote_control_enabled: Option<bool>,
    pub cloud_session_storage_enabled: Option<bool>,
    pub codex_agent_enabled: Option<bool>,
    pub copilot_plan: Option<String>,
    pub copilotignore_enabled: Option<bool>,
    pub endpoints: Option<CopilotUserResponseEndpoints>,
    pub is_mcp_enabled: Option<Value>,
    pub is_staff: Option<bool>,
    pub limited_user_quotas: Option<HashMap<String, f64>>,
    pub limited_user_reset_date: Option<String>,
    pub login: Option<String>,
    pub monthly_quotas: Option<HashMap<String, f64>>,
    pub organization_list: Option<Value>,
    pub organization_login_list: Option<Vec<String>>,
    pub quota_reset_date: Option<String>,
    pub quota_reset_date_utc: Option<String>,
    pub quota_snapshots: Option<CopilotUserResponseQuotaSnapshots>,
    pub restricted_telemetry: Option<bool>,
    pub te: Option<bool>,
    pub token_based_billing: Option<bool>,
}

Snapshot of the authenticated user’s Copilot subscription info, if known. Mirrors the GitHub API /copilot_internal/v2/token user response shape — the runtime trusts this verbatim and does not re-fetch when set.

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

Fields

access_type_sku: Option<String>

Copilot access SKU identifier (e.g. free_limited_copilot, copilot_for_business_seat_quota) used to gate model and feature access.

analytics_tracking_id: Option<String>

Opaque analytics tracking identifier for the user, forwarded from the Copilot API.

assigned_date: Option<Value>

Date the Copilot seat was assigned to the user, if applicable.

can_signup_for_limited: Option<bool>

Whether the user is eligible to sign up for the free/limited Copilot tier.

can_upgrade_plan: Option<bool>

Whether the user is able to upgrade their Copilot plan.

chat_enabled: Option<bool>

Whether Copilot chat is enabled for the user.

cli_remote_control_enabled: Option<bool>

Whether CLI remote control is enabled for the user.

cloud_session_storage_enabled: Option<bool>

Whether cloud session storage is enabled for the user.

codex_agent_enabled: Option<bool>

Whether the Codex agent is enabled for the user.

copilot_plan: Option<String>

Copilot plan name for the user (e.g. individual, business, enterprise).

copilotignore_enabled: Option<bool>

Whether .copilotignore content-exclusion support is enabled for the user.

endpoints: Option<CopilotUserResponseEndpoints>

Endpoint URLs from the raw Copilot /copilot_internal/v2/token user-response passthrough.

is_mcp_enabled: Option<Value>

Whether MCP (Model Context Protocol) support is enabled for the user.

is_staff: Option<bool>

Whether the user is a GitHub/Microsoft staff member.

limited_user_quotas: Option<HashMap<String, f64>>

Per-category quota allotments for free/limited-tier users, keyed by quota category.

limited_user_reset_date: Option<String>

Date the free/limited-tier user’s quotas next reset, as a raw string from the Copilot API.

login: Option<String>

GitHub login of the authenticated user.

monthly_quotas: Option<HashMap<String, f64>>

Per-category monthly quota allotments, keyed by quota category.

organization_list: Option<Value>

Organizations the user belongs to, each with an optional login and display name.

organization_login_list: Option<Vec<String>>

Logins of the organizations the user belongs to.

quota_reset_date: Option<String>

Date the user’s usage quota next resets, as a raw string from the Copilot API; see quota_reset_date_utc for the UTC-normalized value.

quota_reset_date_utc: Option<String>

UTC-normalized form of quota_reset_date (the date the user’s usage quota next resets).

quota_snapshots: Option<CopilotUserResponseQuotaSnapshots>

Quota snapshot map from the raw Copilot user-response passthrough, with chat, completions, premium-interactions, and other entries.

restricted_telemetry: Option<bool>

Whether the user’s telemetry is subject to restricted-data handling.

te: Option<bool>

Raw passthrough of the Copilot API te flag for the user (an opaque server-side eligibility signal surfaced in telemetry); not otherwise interpreted by the runtime.

token_based_billing: Option<bool>

Whether the account is on usage-based (token/AI-credit) billing rather than a fixed premium-request quota.

Trait Implementations

impl Clone for CopilotUserResponse

fn clone(&self) -> CopilotUserResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CopilotUserResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CopilotUserResponse

fn default() -> CopilotUserResponse

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CopilotUserResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CopilotUserResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.