​

ves-io-schema-usage-plan-CustomAPI-GetCurrentPlan

Published April 5, 2023 | Last modified October 28, 2026

Examples of performing plan CustomAPI GetCurrentPlan

Usecase:

Get current plans

Request:

Request using vesctl:

vesctl request rpc plan.CustomAPI.GetCurrentPlan -i request.yaml --uri /public/namespaces/system/usage_plans/current --http-method GET

where file request.yaml has following contents:

{}

vesctl yaml response:

locale: en-us
plans:
- allowedAddonServices: []
  current: true
  description: description
  flatPrice: 100
  includedAddonServices: []
  name: name
  renewalPeriodUnit: PERIOD_MONTH
  state: STATE_READY
  subtitle: 2dn line of title
  tenantType: FREEMIUM
  title: title

Request using curl:

curl -X 'GET' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build3348201650_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/web/namespaces/system/usage_plans/current'

curl response:

HTTP/1.1 200 OK
Content-Length: 612
Content-Type: application/json
Date: Mon, 28 Sep 2026 04:30:34 GMT
Vary: Accept-Encoding


{
  "locale": "en-us",
  "plans": [
    {
      "name": "name",
      "title": "title",
      "description": "description",
      "tenant_type": "FREEMIUM",
      "billing_disabled": false,
      "flat_price": 100,
      "renewal_period_unit": "PERIOD_MONTH",
      "subtitle": "2dn line of title",
      "current": true,
      "default_quota": null,
      "usage_plan_type": "FREE",
      "trial_period_unit": "PERIOD_UNKNOWN",
      "transition_flow": null,
      "state": "STATE_READY",
      "trial_period": 0,
      "included_addon_services": [
      ],
      "allowed_addon_services": [
      ]
    }
  ]
}
On this page: