PricingModel

Represents a PricingModels object.

Pricing model is object who has information about what price should be applied to a product and what rule should be use to show the information as if the Pricing is for some UserType as TEF user or No-TEF user. Has the information about the RecurrenceType (Daily, Monthly, etc) and Quality. API v3.2 includes a "RecurrenceDays" parameter that allows to specify arbitrary number of days for recurrence only if the RecurrenceType is set as "Custom".

Almost all PricingModel is assigned to a PricingModelGroup, even though is possible assign a content direct to one pricing model.

Members

Field	Data Type	Description
Chargingclass	String
DevicesType	DeviceType
GrantAllDevices	bool	Set true or false if all devices will be available for this Pricing Model.
ID	int	A unique id to identify a pricing model.
IsRecurring	bool	Set if the pricing model will be recur in a period specified in RecurrenceType.
Price	doble	A value to be used in a product to indicate the value that should be payed for that.
Quality	Quality
RecurrenceType	RecurrenceType	Indicate the period should use in recurring payment.
RecurrenceDays	int	Only API 3.2 and later: Indicate the number of days for "Custom" recurrence type.
Title	String	Name of the pricing model.
UserType	UserType	Set if the pricing model could be used with TEF user or NO-TEF user or both.

Example

API version < 3.2

{
      "ID": 246,
      "Title": "Estreia HD",
      "Chargingclass": "Locadora Virtual HD",
      "UserType": 1,
      "Price": 9.9,
      "RecurrenceType": 1,
      "DevicesType": [],
      "Isrecurring": false,
      "GrantAllDevices": true,
      "Quality": 2
}

API version > 3.2

{
    "ID": 190,
    "Title": "Test_Custom_TVOD_Series_TEF_inst44",
    "Chargingclass": "",
    "UserType": 1,
    "Price": 2,
    "RecurrenceType": 12,
    "DevicesType": [],
    "Isrecurring": false,
    "GrantAllDevices": true,
    "Quality": 3,
    "RecurrenceDays": 5
}

Known issues

None

Version history

API Version Number	Change description	Changes author
1.0	Initial data type implementation	Harley Cabral
3.2	Included "RecurrenceDays" parameter to be used in "Custom" recurrence type	Pedro Caamaño

See also

RecurrenceType