featureGate(input: FeatureGateCheckInput!): FeatureGate!

Arguments

Argument	Type	Required
`input`	`FeatureGateCheckInput!`	Yes

Input fields

input

FeatureGateCheckInput

Field	Type	Required	Description
`gate`	`String!`	Yes
`currentCount`	`Int`	No
`projectReference`	`String`	No	Optional project ID or slug. When supplied for a gate other than projects, checks the project owner and requires project.read. The projects gate always checks the caller.

Response

Returns FeatureGate!. Open the type for its fields and nested types.

Field	Type	Description
`gate`	`String!`	The gate that was checked.
`allowed`	`Boolean!`
`requiredTier`	`String`
`limit`	`Float`
`currentCount`	`Float`

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql

query FeatureGate($input: FeatureGateCheckInput!) {
  featureGate(input: $input) {
    allowed
    currentCount
    gate
    limit
    requiredTier
  }
}

json

{
  "input": {
    "gate": "custom_domains"
  }
}