Consumption

Get usage quota

Returns how much of the workspace's current usage quota is used, as shown on the Billing page. Requires an organization owner or admin.

<sub>Scope: analytics:read</sub>

get/v3/organizations/{orgId}/usage/quota

Request

  • Base URL: https://api.reasonmachines.com
  • URL: https://api.reasonmachines.com/v3/organizations/{orgId}/usage/quota
  • Auth: HTTP bearer

Response

Usage quota.

label'Monthly quota' | 'Purchased usage' | 'Daily quota' | 'Available usage' required

Which quota the workspace is measured against.

used_percentinteger nullable required

Share of that quota already used, rounded. Purchased usage is measured against everything issued in its current run. Null when the quota has no known total, or the workspace is not metered.

resets_atstring date-time nullable required

When the quota renews: a monthly quota's renewal, or the end of a daily quota's 24-hour window. Null when the quota does not renew or its renewal date is not known.

exhaustedboolean nullable required

True when the workspace has no usage left to start work with. Null when that cannot be determined without starting work.

Changes

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