1. Docs
2. Reference
3. REST API Docs
4. Schema
5. OrgNeoTokenBudget

The effective Neo-token budget for a context: the caller by default, or the owner of the task identified by taskId when that query parameter is supplied. When more than one Neo-token limit is in force (an org-level cap and a per-member cap), this reflects whichever is closest to exhaustion.

Properties

• windowKind enum required
  Kind of cap window applied to the org.
  Values:

  trial — Trial

  One-time allowance across the duration of a subscription trial.

  individual — Individual

  Per calendar-month allowance for a single-user free organization.

  org-dollar — OrgDollar

  Per calendar-month, admin-configured dollar allowance for a multi-user organization.

  member-dollar — MemberDollar

  Per calendar-month, admin-configured dollar allowance for a single member of a multi-user organization.

• baseAllowanceTokens integer required
  Plan-derived base allowance for the current window, in Neo tokens.
• effectiveAllowanceTokens integer required
  Allowance for the current window, in Neo tokens. Includes any active bonus on top of the base allowance.
• consumedTokens integer required
  Total Neo tokens consumed in the current window.
• windowEnd integer required
  Unix epoch timestamp (seconds) when the current window ends and the consumed counter resets. Zero when the window does not reset.
• exhausted boolean required
  True when consumedTokens has reached effectiveAllowanceTokens for the current window.
• baseAllowanceCents integer optional
  Plan-derived base allowance for the current window, in cents. Present only for dollar-denominated window kinds (org-dollar, member-dollar); null otherwise.
• effectiveAllowanceCents integer optional
  Allowance for the current window, in cents. Present only for dollar-denominated window kinds (org-dollar, member-dollar); null otherwise.
• consumedCents integer optional
  Total consumed in the current window, in cents. Present only for dollar-denominated window kinds (org-dollar, member-dollar); null otherwise.