Ir al contenido
NovaFENovaFE

PlansLista los planes comerciales

Lista los planes comerciales

Ver como Markdown
GET
/api/v1/plans
curl --request GET \
  --url https://api.novafe.example/api/v1/plans \
  --header 'X-API-Key: <X-API-Key>'

El catálogo de planes. Está disponible para cualquier usuario autenticado, no solo para el operador: el contribuyente lo necesita para elegir a qué nivel pedir un upgrade. Los planes ocultos (isPublic: false) solo los ve el operador.

Autenticación: requiere una API key válida (header X-API-Key).

Authorizations

Sección titulada «Authorizations»

Parameters

Sección titulada «Parameters»

Query Parameters

Sección titulada «Query Parameters»
activeOnly
boolean

Responses

Sección titulada «Responses»

200

Sección titulada «200»

OK

Array<object>

Un nivel del catálogo de planes.

object
id
required
string format: uuid
key
required
string
displayName
required
string
monthlyPriceDop
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
annualPriceDop
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
includedEcfPerPeriod
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
overagePricePerEcfDop
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
hardCap
required
boolean
includedTenants
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
tenantOveragePriceDop
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
tenantHardCap
required
boolean
includedMembers
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
memberOveragePriceDop
required
number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
memberHardCap
required
boolean
requestsPerMinute
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
sortOrder
required
integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
active
required
boolean
customPricing
required
boolean
supportLabel
required
null | string
slaLabel
required
null | string
targetDescription
required
null | string
isPublic
required
boolean
paidEnvironmentsEnabled
required
boolean