OpenapiCaptable
Create plans
Opens an equity plan that options are granted from.
POST /v1/captable/plans
| Address | https://api.hanzo.ai/v1/captable/plans |
| Method | POST |
| Operation | post_captable_plans |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Opens an equity plan that options are granted from.
Request
7 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
boardApprovalDate | body | any | — | BoardApprovalDate is when the board adopted the plan, YYYY-MM-DD. |
comments | body | any | — | Comments is a free-text note kept with the plan. |
defaultCancellatonBehavior | body | any | — | DefaultCancellatonBehavior is what happens to cancelled grants: RETIRE, RETURN_TO_POOL, HOLD_AS_CAPITAL_STOCK or DEFINED_PER_PLAN_SECURITY. |
initialSharesReserved | body | any | — | InitialSharesReserved is how many shares the plan may grant. |
name | body | any | — | Name is the plan's name, e.g. |
planEffectiveDate | body | any | — | PlanEffectiveDate is when the plan takes effect, YYYY-MM-DD. |
shareClassId | body | any | — | ShareClassID is the class the plan grants from. |
Response
| Status | Body | Meaning |
|---|---|---|
201 | captableCreated | created |
201 body — 3 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
id | body | string | — | ID is the created row's id. |
message | body | string | — | Message is the human sentence the cap table wrote, e.g. |
success | body | boolean | — | Success is true when the row was written. |
Failure carries the platform error shape — see Errors.
Examples
hanzo captable plans createimport { Configuration, CaptableApi } from 'hanzoai';
const api = new CaptableApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postCaptablePlans({ boardApprovalDate: "<boardApprovalDate>", comments: "<comments>" });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import CaptableApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = CaptableApi(client).post_captable_plans(board_approval_date="<boardApprovalDate>", comments="<comments>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.CaptableAPI.PostCaptablePlans(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, captable_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = captable_api::post_captable_plans(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CaptableApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new CaptableApi(client).postCaptablePlans();curl -X POST https://api.hanzo.ai/v1/captable/plans \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"boardApprovalDate": "<boardApprovalDate>",
"comments": "<comments>"
}'MCP reaches captable through the captable tool, which names its 31 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_captable_classes"
}
}
}'How is this guide?