VOD Product data model

Name	Type	Description	Localised	Always available
`_id`	String	Internal identifier for the object.	No	Yes
`businessProductType`	String	A numeric value provided by the CAS to classify the type of product.	No	No
`casId`	String	The identifier of this product within the CAS. This is the technical ID for all conditional-access-related operations. For the NAGRA CAS, this ID is a numeric value with up to 12 digits.	No	No
`casInstanceName`	String	The name that uniquely identifies the CAS server that manages access to this channel or event.	No	No
`casMopId`	String	The MOP ID assigned by the NAGRA CAS to this product, if applicable. The presence of this value depends upon the CAS features that have been activated for the customer project.	No	No
`endPurchase`	String: a date and time in ISO 8601 format	The end date and time of the period when the end user may purchase this product.	No	No
`endValidity`	String: a date and time in ISO 8601 format	The end date and time of the period when this product is valid. Access to the content/event sold by this product is not allowed after this time.	No	No
`id`	String	The CMS's identifier for the object.	No	Yes
`impulsive`	Boolean	Whether the product can be acquired by the end-user “impulsively”, that is, without requiring a right to be delivered explicitly from the head-end. CMS 4 always sets this field to `true`.	No	No
`isSOCU`	Boolean	Whether start-up and catch-up can be used with this content. For PPV and subscription products, the default is configured in the CMS. For other products, the default value is `false`.	No	No
`ordering`	Boolean	Whether the product can be acquired by the end-user in “ordering” mode, that is, via a right delivered from the head-end. CMS 4 always sets this field to `false`.	No	No
`payMode`	String	Indicates how the product can be paid for when acquired in "ordering" mode. Must be one of: `payableLocally`, `voucher`, or`other`. This field should not be present if `ordering` is `false`.	No	No
`payPerTime`	Boolean	Whether this a pay-per-time product.	No	No
`price`	Sub-object	The prices this product can be purchased for. (See following rows.) MDS only currently supports one price in one currency per product.	No	No
`price.currency`	String	The currency the price is in.	No	Yes
`price.endPurchase`	String: a date and time in ISO 8601 format	The end date and time of the period when the end user may purchase the product at this price.	No	No
`price.providerId`	String	The identifier of the metadata provider, from the `id` of the export's `CMSVodData` element.	No	Yes
`price.startPurchase`	String: a date and time in ISO 8601 format	The start date and time of the period when the end user may purchase the product at this price.	No	No
`price.value`	Number	The value of the price in the specified currency.	No	Yes
`PrivateMetadata`	String	Used to pass data directly from the customer to the end-user device without any processing. One possible use is to pass a list of keyword/value pairs, separated by semi-colons. No validation is done by the Metadata Server on the value of this field.	No	No
`ProfileName`	String	Allows a product to be associated to an externally-managed profile.	No	No
`promotions`	Array of strings	A list of IDs of promotions that apply to this product. Since MDS 1.2.	No	No
`provider`	String	The identifier of the metadata provider, from the `id` of the export's `CMSVodData` element.	No	Yes
`rentalDuration`	Integer	Number of seconds from the first viewing during which a VOD asset can still be watched (for example, `86400`).	No	No
`startPurchase`	String: a date and time in ISO 8601 format	The start date and time of the period when the end user may purchase this product.	No	No
`startValidity`	String: a date and time in ISO 8601 format	The start date and time of the period when this product is valid. Access to the content/event sold by this product is not allowed before this time.	No	No
`title`	String	The name of the product. This field is not localised. Multi-language clients should use the `TitleForProduct` field instead	No	Yes
`TitleForProduct`	String	The name of the product.	Yes	No
`type`	String	The type of product. Must be one of: `subscription`, `single`, `multiple`, or `bundle`. `single` products reference only one content item. `multiple` products reference an immutable selection of content items, payable in a single transaction. `subscription` products reference a mutable selection of content items, payable as a recurring subscription.	No	Yes
`xml`	String	The type of object. Always `Product`.	No	Yes