Product.Ingress

API: Internal/Beta

An ingress Product

data class Ingress(
    val name: String,
    val pricePerUnit: Long,
    val category: ProductCategoryId,
    val description: String?,
    val priority: Int?,
    val version: Int?,
    val freeToUse: Boolean?,
    val unitOfPrice: ProductPriceUnit?,
    val chargeType: ChargeType?,
    val hiddenInGrantApplications: Boolean?,
    val productType: ProductType,
    val balance: Long?,
    val id: String,
    val type: String /* "ingress" */,
)

Unit

API

Measured in number of ingresses

Click here

Properties
name: String A unique name associated with this Product
pricePerUnit: Long The price of a single unit in a single period

For more information go here.

category: ProductCategoryId The category groups similar products together, it also defines which provider owns the product
description: String? A short (single-line) description of the Product
priority: Int? A integer used for changing the order in which products are displayed (ascending order)
version: Int? A version number for this Product, managed by UCloud
freeToUse: Boolean? Indicates that a Wallet is not required to use this Product

Under normal circumstances, a Wallet is always required. This is required even if a Product has a pricePerUnit of 0. If freeToUse = true then the Wallet requirement is dropped.

unitOfPrice: ProductPriceUnit? The unit of price. Used in combination with chargeType to create a complete payment model.
chargeType: ChargeType? The category of payment model. Used in combination with unitOfPrice to create a complete payment model.
hiddenInGrantApplications: Boolean? Flag to indicate that this Product is not publicly available

⚠️ WARNING: This doesn’t make the Product secret. In only hides the Product from the grant system’s UI.

productType: ProductType
balance: Long? Included only with certain endpoints which support `includeBalance`
id: String

Deprecated: Yes

type: String /* "ingress" */ The type discriminator

API: Stable