FrameSDK/com.framepayments.framesdk.products/Product

Product

data class Product(val id: String?, val name: String?, val livemode: Boolean?, val image: String?, val description: String?, val url: String?, val shippable: Boolean?, val active: Boolean?, val metadata: Map<String, String>?, val created: Int?, val updated: Int?, val defaultPrice: Int?, val productObject: String?)

Represents a product defined by the merchant in the Frame platform.

Constructors

constructor(id: String?, name: String?, livemode: Boolean?, image: String?, description: String?, url: String?, shippable: Boolean?, active: Boolean?, metadata: Map<String, String>?, created: Int?, updated: Int?, defaultPrice: Int?, productObject: String?)

Properties

val active: Boolean?

Whether the product is currently available for purchase.

val created: Int?

Unix timestamp of when the product was created.

@SerializedName(value = "default_price")

val defaultPrice: Int?

The default price for the product, in the smallest currency unit (e.g. cents).

val description: String?

Human-readable description of the product.

val id: String?

Unique identifier for the product.

val image: String?

URL of the product image.

val livemode: Boolean?

Whether the product was created in live mode (true) or test mode (false).

val metadata: Map<String, String>?

Merchant-defined key-value pairs attached to the product.

val name: String?

Display name of the product.

@SerializedName(value = "object")

val productObject: String?

The object type identifier returned by the API (typically "product").

val shippable: Boolean?

Whether the product requires physical shipment to the customer.

val updated: Int?

Unix timestamp of when the product was last updated.

val url: String?

URL for the product's external page or listing.