Skip to content
Raster
Esc
navigateopen⌘Jpreview

list plans

GET/v1/plans
Responses
200OK
dataPlanDefinition[]required
Show properties
Array of PlanDefinition
idPlanIdrequired
Allowed:freedeveloperprostartupenterprise
namestringrequired
min length 1 · max length 64
descriptionstring | anyrequired
Show properties
Any of:
string
string
any
any
catalog_versionstringrequired
min length 1
effective_atstring<date-time>required
currencystringrequired
min length 3 · max length 3
base_priceinteger | anyrequired
Show properties
Any of:
integer
integer
any
any
intervalstringrequired
Allowed:monthyear
custombooleanrequired
entitlementsPlanEntitlementsrequired
Show properties
max_running_machinesinteger | anyrequired
null means negotiated per organization; it never means unlimited
Show properties
Any of:
integer
integer
any
any
max_machinesinteger | anyrequired
null means negotiated per organization; it never means unlimited
Show properties
Any of:
integer
integer
any
any
max_snapshots_per_machineinteger | anyrequired
null means negotiated per organization; it never means unlimited
Show properties
Any of:
integer
integer
any
any
max_templatesinteger | anyrequired
null means negotiated per organization; it never means unlimited
Show properties
Any of:
integer
integer
any
any
max_membersinteger | anyrequired
null means negotiated per organization; it never means unlimited
Show properties
Any of:
integer
integer
any
any
max_concurrent_sessionsinteger | anyrequired
null means negotiated per organization; it never means unlimited
Show properties
Any of:
integer
integer
any
any
max_machine_sizeMachineSize | anyrequired
Show properties
Any of:
MachineSize
string
any
any
included_standard_secondsinteger | anyrequired
null means negotiated per organization; it never means unlimited
Show properties
Any of:
integer
integer
any
any
included_hot_storage_gbinteger | anyrequired
null means negotiated per organization; it never means unlimited
Show properties
Any of:
integer
integer
any
any
included_egress_gbinteger | anyrequired
null means negotiated per organization; it never means unlimited
Show properties
Any of:
integer
integer
any
any
allows_overagebooleanrequired
compute_ratesComputeRate[]required
Show properties
Array of ComputeRate
sizeMachineSizerequired
Allowed:smallstandardlarge
currencystringrequired
min length 3 · max length 3
standard_hour_weight_milliintegerrequired
min -9007199254740991 · max 9007199254740991
price_per_hourintegerrequired
price in the minor unit of `currency`, e.g. cents
min 0 · max 9007199254740991
storage_ratesStorageRate[]required
Show properties
Array of StorageRate
classStorageClassrequired
Allowed:hotcold
currencystringrequired
min length 3 · max length 3
price_per_gb_monthintegerrequired
price in the minor unit of `currency`, e.g. cents
min 0 · max 9007199254740991
egress_rateEgressRaterequired
Show properties
currencystringrequired
min length 3 · max length 3
price_per_gbintegerrequired
price in the minor unit of `currency`, e.g. cents
min 0 · max 9007199254740991
availablebooleanrequired
400invalid request
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
401unauthenticated
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
402quota exceeded
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
403permission denied
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
404not found
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
409conflict with current state
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
412precondition failed
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
429rate limited
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
500internal error
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
501unsupported operation
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
503compute unavailable
errorobjectrequired
Show properties
codeErrorCoderequired
Allowed:invalid_requestunauthenticatedpermission_deniednot_foundconflictprecondition_failedquota_exceededrate_limitedunsupported_operationinternal_errorcompute_unavailable
messagestringrequired
human-readable, not machine-parseable
request_idstringrequired
detailsFieldError[]
Show properties
Array of FieldError
fieldstringrequired
dotted path into the request body
messagestringrequired
quotaobject
Show properties
limitstringrequired
the entitlement that declined this request
currentintegerrequired
min 0 · max 9007199254740991
maximuminteger | anyrequired
Show properties
Any of:
integer
integer
any
any
plan_idstringrequired
upgrade_urlstring | anyrequired
Show properties
Any of:
string
string
any
any
Try it
Server
Request
curl -X GET "https://api.raster.sh/v1/v1/plans"
Response
{
  "data": [
    {
      "id": "free",
      "name": "string",
      "description": "string",
      "catalog_version": "string",
      "effective_at": "2026-08-19T12:00:00Z",
      "currency": "USD",
      "base_price": 9007199254740991,
      "interval": "month",
      "custom": true,
      "entitlements": {
        "max_running_machines": 9007199254740991,
        "max_machines": 9007199254740991,
        "max_snapshots_per_machine": 9007199254740991,
        "max_templates": 9007199254740991,
        "max_members": 9007199254740991,
        "max_concurrent_sessions": 9007199254740991,
        "max_machine_size": "small",
        "included_standard_seconds": 9007199254740991,
        "included_hot_storage_gb": 9007199254740991,
        "included_egress_gb": 9007199254740991,
        "allows_overage": true
      },
      "compute_rates": [
        {
          "size": "small",
          "currency": "USD",
          "standard_hour_weight_milli": -9007199254740991,
          "price_per_hour": 9007199254740991
        }
      ],
      "storage_rates": [
        {
          "class": "hot",
          "currency": "USD",
          "price_per_gb_month": 9007199254740991
        }
      ],
      "egress_rate": {
        "currency": "USD",
        "price_per_gb": 9007199254740991
      },
      "available": true
    }
  ]
}