Skip to main content

effectiveQuota

Resolves the single most-specific quota that applies to the given (tierId, appId, orgId, metric) by walking tier -> app -> org -> free-tier defaults and returning the first match; its limitValue/period describe the enforced limit. Returns null if no matching rule and no free-tier default exist for the metric. Requires the 'view_usage' permission on the most-specific scope provided: tierId or appId -> 'view_usage' on the (owning) app; orgId -> 'view_usage' on the org. A metric-only query (no scope ids) resolves the platform free-tier default and only requires an authenticated user.

effectiveQuota(
  metric: String!
  orgId: BigInt
  appId: BigInt
  tierId: BigInt
): ServiceQuota

Arguments​

effectiveQuota.metric ● String! non-null scalar​

The metered resource key to resolve (max 64 characters), e.g. "api_requests".

effectiveQuota.orgId ● BigInt scalar​

Organization context (BigInt as a decimal string). Optional; include to consider org-scoped rules in the precedence walk.

effectiveQuota.appId ● BigInt scalar​

App context (BigInt as a decimal string). Optional; include to consider app-scoped rules in the precedence walk.

effectiveQuota.tierId ● BigInt scalar​

Access tier context (BigInt as a decimal string). Optional; include to consider tier-scoped rules (the most specific level).

Type​

ServiceQuota object​