veryfront__get_subscriptionAccess
No external-service connection is required. Use a Veryfront credential with access to the requested resources. Call type: Read-only.Arguments
See the full schema below for the accepted shape and constraints.Example request
Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.request.json
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "veryfront__get_subscription",
"arguments": {}
}
}
Result
The published output shape is summarized below. Inspect both the MCP response content andisError when handling a call.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
id | string or null | No | Billing record ID. Null, or absent under external billing, when the account has no stored billing record. |
project_id | string or null | No | Project this subscription is scoped to, when applicable |
line_items | object[] | No | Subscription line items. Credits are one-time top-ups and are not included here. |
seat_usage | object or null | No | Seat usage that seat changes and invitations are checked against. Served on every read by a user session, including an account without a stored billing record. |
status | string or null | No | Subscription status |
current_period_start | string or null | No | Current billing period start timestamp |
current_period_end | string or null | No | Current billing period end timestamp |
expires_at | string or null | No | Subscription expiration timestamp |
canceled_at | string or null | No | Subscription cancellation timestamp |
created_at | string or null | No | Billing record creation time. Null, or absent under external billing, when the account has no stored billing record. |
user_id | string | No | Captured financial actor UUID retained for compatibility; the account owns the subscription |
Full schemas
{
"type": "object",
"properties": {},
"additionalProperties": false,
"description": "No arguments. Returns status and expiration. The authenticated user’s subscription. Under external billing, configured entitlements are returned for an existing user even without a stored subscription. Without a stored billing record under Stripe billing, the free plan is returned with no record id. Seat usage, the usage that seat changes and invitations are checked against, is returned on every read.",
"$schema": "http://json-schema.org/draft-07/schema#"
}
{
"type": "object",
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "Billing record ID. Null, or absent under external billing, when the account has no stored billing record."
},
"project_id": {
"type": [
"string",
"null"
],
"description": "Project this subscription is scoped to, when applicable"
},
"line_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"plan",
"seat",
"server",
"sandbox"
],
"description": "Subscription line item kind"
},
"quantity": {
"type": "number",
"description": "Line item quantity"
}
},
"required": [
"kind",
"quantity"
],
"additionalProperties": false
},
"description": "Subscription line items. Credits are one-time top-ups and are not included here."
},
"seat_usage": {
"anyOf": [
{
"type": "object",
"properties": {
"purchased": {
"type": "integer",
"minimum": 0,
"description": "Seats the account can use, including the owner seat"
},
"active": {
"type": "integer",
"minimum": 0,
"description": "Active members on projects the account owns"
},
"reserved": {
"type": "integer",
"minimum": 0,
"description": "Pending invitation emails that hold a seat on projects the account owns"
},
"used": {
"type": "integer",
"minimum": 0,
"description": "Seats in use: active plus reserved"
},
"available": {
"type": "integer",
"minimum": 0,
"description": "Purchased seats that are not in use"
},
"over_capacity": {
"type": "boolean",
"description": "True when used seats exceed purchased seats"
}
},
"required": [
"purchased",
"active",
"reserved",
"used",
"available",
"over_capacity"
],
"additionalProperties": false,
"description": "Seat usage that seat changes and invitations are checked against"
},
{
"type": "null",
"description": "The seat usage returned by the tool."
}
],
"description": "Seat usage that seat changes and invitations are checked against. Served on every read by a user session, including an account without a stored billing record."
},
"status": {
"type": [
"string",
"null"
],
"description": "Subscription status"
},
"current_period_start": {
"type": [
"string",
"null"
],
"description": "Current billing period start timestamp"
},
"current_period_end": {
"type": [
"string",
"null"
],
"description": "Current billing period end timestamp"
},
"expires_at": {
"type": [
"string",
"null"
],
"description": "Subscription expiration timestamp"
},
"canceled_at": {
"type": [
"string",
"null"
],
"description": "Subscription cancellation timestamp"
},
"created_at": {
"type": [
"string",
"null"
],
"description": "Billing record creation time. Null, or absent under external billing, when the account has no stored billing record."
},
"user_id": {
"type": "string",
"description": "Captured financial actor UUID retained for compatibility; the account owns the subscription"
}
},
"additionalProperties": false,
"description": "Structured result returned by the get_subscription tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}