Kong · Schema

BillingEntitlementAccessResult

Entitlement access result.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name	Type	Description
type	string	The type of the entitlement.
feature_key	string	The feature key of the entitlement.
has_access	boolean	Whether the customer has access to the feature. Always true for `boolean` and `static` entitlements. Depends on balance for `metered` entitlements.
config	string	Only available for static entitlements. Config is the JSON parsable configuration of the entitlement. Useful to describe per customer configuration.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BillingEntitlementAccessResult",
  "title": "BillingEntitlementAccessResult",
  "description": "Entitlement access result.",
  "type": "object",
  "properties": {
    "type": {
      "description": "The type of the entitlement.",
      "type": "string",
      "example": "static",
      "enum": [
        "metered",
        "static",
        "boolean"
      ],
      "readOnly": true,
      "x-speakeasy-unknown-values": "allow"
    },
    "feature_key": {
      "description": "The feature key of the entitlement.",
      "type": "string",
      "example": "available_models",
      "maxLength": 64,
      "minLength": 1,
      "pattern": "^[a-z0-9]+(?:_[a-z0-9]+)*$",
      "readOnly": true,
      "title": "Resource Key"
    },
    "has_access": {
      "description": "Whether the customer has access to the feature.\nAlways true for `boolean` and `static` entitlements.\nDepends on balance for `metered` entitlements.",
      "type": "boolean",
      "example": true,
      "readOnly": true
    },
    "config": {
      "description": "Only available for static entitlements.\nConfig is the JSON parsable configuration of the entitlement.\nUseful to describe per customer configuration.",
      "type": "string",
      "example": "{ \"availableModels\": [\"gpt-5\", \"gpt-4o\"] }",
      "readOnly": true
    }
  },
  "required": [
    "type",
    "feature_key",
    "has_access"
  ]
}