Get entitlements

Returns what one plan GRANTS and not what it costs: the canonical namespaced entitlement block and the flat license-feature list derived from it.

GET /v1/plan/entitlements/{id}

Addresshttps://api.hanzo.ai/v1/plan/entitlements/{id}
MethodGET
Operationget_plan_entitlements_by_id
AuthAuthorization: Bearer $HANZO_API_KEY

Returns what one plan GRANTS and not what it costs: the canonical namespaced entitlement block and the flat license-feature list derived from it. It is the entitlement half of ResolvePlan, over the same catalog and the same 404 for an id no catalog holds — the read a licensing or quota gate makes.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the plan's catalog id or slug — "dev", "max", "team", "rpc-growth".

Response

StatusBodyMeaning
200plan.planEntitlementsok
defaultproblem-detailsrefused

200 body — 3 fields.

FieldInTypeAlwaysDescription
entitlementsbodyany—Entitlements is the canonical namespaced entitlement block derived from the plan's limits and addons, where -1 means unlimited.
idbodystring—ID is the plan id or slug that was resolved, as it was requested.
license_featuresbodystring[]—LicenseFeatures is the flat, sorted feature list a signed license carries, derived from the entitlements.

Failure carries the platform error shape — see Errors.

Examples

hanzo plan entitlements get <id>
import { Configuration, PlanApi } from 'hanzoai';

const api = new PlanApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPlanEntitlementsById({ id: 'id' });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PlanApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PlanApi(client).get_plan_entitlements_by_id(id='id')
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.PlanAPI.GetPlanEntitlementsById(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, plan_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = plan_api::get_plan_entitlements_by_id(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PlanApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new PlanApi(client).getPlanEntitlementsById();
curl https://api.hanzo.ai/v1/plan/entitlements/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches plan through the plan tool, which names its 14 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_plans"
         }
       }
     }'

Plan API · All Hanzo APIs · Interactive reference

Was this page useful?