Skip to main content
GET
cURL

Path Parameters

planVersionID
string<uuid>
required

Query Parameters

locale
enum<string>
Available options:
ru,
en

Response

Plan

planId
string<uuid>
required
planVersionId
string<uuid>
required
code
string
required
kind
enum<string>
required
Available options:
trial,
one_time,
recurring,
manual
name
string
required
billingPeriod
string
required
durationSeconds
integer<int64>
required
price
object
required
operations
enum<string>[]
required

The lifecycle actions the configured plan policy allows for this customer.

Available options:
purchase,
extension,
upgrade,
downgrade
eligible
boolean
required
squads
object
required
addons
object[]
required
promotions
object[]
required
description
string
sortOrder
integer
gracePeriodSeconds
integer<int64>
recurringCapable
boolean
configurableSquads
boolean
held
boolean

The customer already holds an entitlement for this plan, so the catalogue can mark it as the one they are on.

ineligibleReason
string
trafficAllowanceBytes
integer<int64> | null

Null means unlimited. Nullable rather than zero because unlimited and none are different offers.

deviceLimit
integer | null

Null means unlimited.

termsUrl
string