Get Equity Subscription Access
equity_onboarding_get_subscription_accessReads company setup and current equity subscription access from Stripe for a company reader. Read this before cap-table work and after the person returns from paying. Complete company proof before requesting a payment link. Where payment_required is true, continue cap-table work only when setup_complete and subscription_active are true. A link, paid_at receipt, or the person's claim of payment never proves current access. Errors mean access could not be checked; never treat them as paid or free.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"companyId": "<companyId>"
},
"name": "equity_onboarding_get_subscription_access"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| companyId | Yes | UUID value wrapper. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| setupStarted | No | ||
| canChoosePlan | No | ||
| setupComplete | No | ||
| detailsComplete | No | ||
| paymentRequired | No | ||
| subscriptionState | No | ||
| subscriptionActive | No |