Neo

GetOrgNeoTokenBudget

Returns the current Neo-token allowance and consumption for the binding (closest-to-exhaustion) in-force Neo limit for a context. Returns 404 when no Neo-token cap applies to this organization.

get/api/orgs/{orgName}/neo/token-budget

Request

  • Base URL: https://api.pulumi.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pulumi.com/api/orgs/{orgName}/neo/token-budget
  • Auth: none declared

Path parameters

orgNamestring required

The organization name

Query parameters

taskIdstring

When supplied, returns the budget for this task's owner instead of the caller. Must resolve to a task within orgName.

Response

OK

baseAllowanceCentsinteger

Plan-derived base allowance for the current window, in cents. Present only for dollar-denominated window kinds (org-dollar, member-dollar); null otherwise.

baseAllowanceTokensinteger required

Plan-derived base allowance for the current window, in Neo tokens.

consumedCentsinteger

Total consumed in the current window, in cents. Present only for dollar-denominated window kinds (org-dollar, member-dollar); null otherwise.

consumedTokensinteger required

Total Neo tokens consumed in the current window.

effectiveAllowanceCentsinteger

Allowance for the current window, in cents. Present only for dollar-denominated window kinds (org-dollar, member-dollar); null otherwise.

effectiveAllowanceTokensinteger required

Allowance for the current window, in Neo tokens. Includes any active bonus on top of the base allowance.

exhaustedboolean required

True when consumedTokens has reached effectiveAllowanceTokens for the current window.

windowEndinteger required

Unix epoch timestamp (seconds) when the current window ends and the consumed counter resets. Zero when the window does not reset.

windowKind'trial' | 'individual' | 'free' | 'org-dollar' | 'member-dollar' required

Kind of cap window applied to the org.

Changes

No recorded changes to this operation across all 1 revision of this API.