Get workspace plan

GET

/v1/workspaces/{workspace_id}/plan

GET

/v1/workspaces/{workspace_id}/plan

Report the workspace plan, its status, limits, and current usage against them.

Authorization

workspaceToken

headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id

Formatuuid

Response Body

Successful Response

application/json

response

billing*

How the workspace pays for its plan and which self-serve billing actions apply.

current_period_end*|null

current_period_start*|null

enforcement_enabled*Enforcement Enabled

Whether limits refuse new work (402) or are only reported.

features*

group?|

The workspaces the subscription covers. Repositories, processing and the workspace count are shared by all of them.

limits*

Plan allowances; null means the plan sets no limit. No plan limits members.

plan*PlanId

Value in"trial""starter""growth""enterprise"

plan_name*Plan Name

processing?|

Processing units this period; null where not reported.

status*SubscriptionStatus

Value in"trialing""active""past_due""canceled""expired"

trial_days_remaining*integer|null

trial_ends_at*|null

usage*

Usage against the plan. Veriom-funded processing is reported in processing units (WorkspacePlanResponse.processing), never as Veriom's model spend (VER-336).

Spend through the workspace's own model keys stays in US dollars: the workspace's providers bill it, so it is the workspace's own spend, not Veriom's cost.

Example Request

curl -X GET 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/plan'

Example Request

curl -X GET 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/plan'

Example ResponseSchema

{
  "billing": {
    "cancel_at_period_end": true,
    "checkout_options": [
      {
        "amount_usd": "string",
        "interval": "month",
        "plan": "starter"
      }
    ],
    "checkout_plans": [
      "starter"
    ],
    "interval": "month",
    "portal_available": true,
    "provider": "stripe",
    "self_serve": true,
    "top_up_carryover": false,
    "top_up_packs": [
      {
        "amount_usd": "string",
        "id": "string",
        "units": 0
      }
    ],
    "yearly_discount_percent": "string"
  },
  "current_period_end": "2019-08-24T14:15:22Z",
  "current_period_start": "2019-08-24T14:15:22Z",
  "enforcement_enabled": true,
  "features": {
    "audit_streaming": true,
    "compliance_programs": true,
    "continuous_audits": true,
    "custom_model_endpoints": true,
    "customer_model_keys": true,
    "enterprise_identity": true,
    "require_two_factor": true
  },
  "group": {
    "billing_workspace_id": "19a63606-6efb-45b2-b603-bf7dc44e4eaf",
    "billing_workspace_name": "string",
    "can_add_workspace": false,
    "covered": true,
    "over_limit": 0,
    "workspaces": 0
  },
  "limits": {
    "api_tokens": 0,
    "audits_per_month": 0,
    "processing_units": 0,
    "repositories": 0,
    "workspaces": 0
  },
  "plan": "trial",
  "plan_name": "string",
  "processing": {
    "allowance": "monthly",
    "budget_units": "string",
    "included_units": 0,
    "last_assessed_at": "2019-08-24T14:15:22Z",
    "minimum_assessment_units": 0,
    "period": "string",
    "remaining_units": "string",
    "reserved_units": "string",
    "resets_at": "2019-08-24T14:15:22Z",
    "state": "ok",
    "used_units": "string",
    "warning_percent": 0
  },
  "status": "trialing",
  "trial_days_remaining": 0,
  "trial_ends_at": "2019-08-24T14:15:22Z",
  "usage": {
    "api_tokens_active": 0,
    "audits_this_month": 0,
    "customer_model_cap_usd": "string",
    "customer_model_spend_usd": "0",
    "repositories_enabled": 0
  }
}

{  "billing": {    "cancel_at_period_end": true,    "checkout_options": [      {        "amount_usd": "string",        "interval": "month",        "plan": "starter"      }    ],    "checkout_plans": [      "starter"    ],    "interval": "month",    "portal_available": true,    "provider": "stripe",    "self_serve": true,    "top_up_carryover": false,    "top_up_packs": [      {        "amount_usd": "string",        "id": "string",        "units": 0      }    ],    "yearly_discount_percent": "string"  },  "current_period_end": "2019-08-24T14:15:22Z",  "current_period_start": "2019-08-24T14:15:22Z",  "enforcement_enabled": true,  "features": {    "audit_streaming": true,    "compliance_programs": true,    "continuous_audits": true,    "custom_model_endpoints": true,    "customer_model_keys": true,    "enterprise_identity": true,    "require_two_factor": true  },  "group": {    "billing_workspace_id": "19a63606-6efb-45b2-b603-bf7dc44e4eaf",    "billing_workspace_name": "string",    "can_add_workspace": false,    "covered": true,    "over_limit": 0,    "workspaces": 0  },  "limits": {    "api_tokens": 0,    "audits_per_month": 0,    "processing_units": 0,    "repositories": 0,    "workspaces": 0  },  "plan": "trial",  "plan_name": "string",  "processing": {    "allowance": "monthly",    "budget_units": "string",    "included_units": 0,    "last_assessed_at": "2019-08-24T14:15:22Z",    "minimum_assessment_units": 0,    "period": "string",    "remaining_units": "string",    "reserved_units": "string",    "resets_at": "2019-08-24T14:15:22Z",    "state": "ok",    "used_units": "string",    "warning_percent": 0  },  "status": "trialing",  "trial_days_remaining": 0,  "trial_ends_at": "2019-08-24T14:15:22Z",  "usage": {    "api_tokens_active": 0,    "audits_this_month": 0,    "customer_model_cap_usd": "string",    "customer_model_spend_usd": "0",    "repositories_enabled": 0  }}

Get workspace plan

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Response Body