IntelligenceX

API Reference

Class

ChatGptUsageSnapshot

Namespace IntelligenceX.OpenAI.Usage
Assembly IntelligenceX
Modifiers sealed

Represents a usage snapshot returned by ChatGPT usage endpoints.

Inheritance

  • Object
  • ChatGptUsageSnapshot

Usage

Explore 7 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 3

Constructors

public ChatGptUsageSnapshot(String? userId, String? accountId, String? email, String? planType, ChatGptRateLimitStatus? rateLimit, IReadOnlyList<ChatGptNamedRateLimit>? additionalRateLimits, ChatGptCreditsSnapshot? credits, JsonObject raw, JsonObject? additional) #

Initializes a new usage snapshot.

Parameters

userId System.String? requiredposition: 0
accountId System.String? requiredposition: 1
email System.String? requiredposition: 2
planType System.String? requiredposition: 3
rateLimit IntelligenceX.OpenAI.Usage.ChatGptRateLimitStatus? requiredposition: 4
additionalRateLimits System.Collections.Generic.IReadOnlyList<IntelligenceX.OpenAI.Usage.ChatGptNamedRateLimit>? requiredposition: 5
credits IntelligenceX.OpenAI.Usage.ChatGptCreditsSnapshot? requiredposition: 6
raw IntelligenceX.Json.JsonObject requiredposition: 7
additional IntelligenceX.Json.JsonObject? requiredposition: 8

Methods

public static ChatGptUsageSnapshot FromJson(JsonObject obj) #
Returns: ChatGptUsageSnapshot

Creates a snapshot from a JSON object.

Parameters

obj IntelligenceX.Json.JsonObject requiredposition: 0
Source JSON object.

Returns

The parsed snapshot.

public JsonObject ToJson() #
Returns: JsonObject

Serializes the snapshot to a JSON object.

Properties

public String? UserId { get; } #

Gets the user id.

public String? AccountId { get; } #

Gets the account id.

public String? Email { get; } #

Gets the account email.

public String? PlanType { get; } #

Gets the plan type identifier.

public ChatGptRateLimitStatus? RateLimit { get; } #

Gets the main rate limit status.

public ChatGptCreditsSnapshot? Credits { get; } #

Gets the credits snapshot.

public ChatGptResetCredits? ResetCredits { get; } #

Reset grant counts, expiry details, and retained history, when available.

public String? ResetCreditsError { get; } #

Safe availability message when optional reset information could not be retrieved.

public ChatGptAccountAnalytics? AccountAnalytics { get; } #

Account-wide provider statistics and accounting, independent of machine-local logs.

public IReadOnlyList<ChatGptNamedRateLimit> AdditionalRateLimits { get; } #

Gets any additional named rate limits returned by the API.

public JsonObject Raw { get; } #

Gets the raw JSON object.

public JsonObject? Additional { get; } #

Gets unrecognized fields from the payload.