Tariff plans (pricelist)

pricelist

Result: list of elements

Tariff plans

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique identifier of the tariff plan.
`name`	String	no	Name of the tariff plan.
`employee_name`	String	no	Internal name (name for employees).
`itemtype_name`	String	no	Service type to which the tariff plan belongs to.
`project`	Positive integer	no	Provider of the tariff plan.
`status`	String (enumeration)	no	Additional information about the tariff plan.
`prorataday`	Positive integer	no	Calendar-based billing. Transition day.of the month.
`note`	String	no	Internal notes on the tariff for employees.
`accessname`	String	no	Access groups for which ordering the tariff is allowed or prohibited.
`processingmodules`	String	no	Processing modules connected to the tariff plan.
`orderpriority`	Positive integer	no	Tariff priority during sorting (ascending).
`pricelist_cost`	String	no	Base cost of tariff plan order periods.

Create tariff plan

Function: pricelist.add

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → click Add.

Creation parameters match the parameters of the function pricelist.edit.

Access level: admin

Parameter	Type	Required	Value
`name`	String	yes	Name of the tariff plan being created.
`sok`	String	yes	The value `ok` confirms operation execution.

Edit tariff plan

Function: pricelist.edit

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Edit.

Allows viewing, modifying, or creating an object.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	yes	Unique identifier of the tariff plan being edited.
`name`	String	no	Name of the tariff plan.
`employee_name`	String	no	Internal name for employees.
`intname`	String	no	Internal service name. Used to obtain default values from the processing module.
`project`	Positive integer	no	Provider of the tariff plan.
`processingmodule`	Positive integer	no	Service processing module connected to the tariff plan.
`billdaily`	Flag	no	Daily billing. When enabled, payment is deducted daily proportional to the dayly cost.
`billhourly`	Flag	no	Hourly billing. Client gains rights to start and stop services.
`billprorata`	Flag	no	Calendar-based billing. Aligns service validity period to calendar month.
`prorataday`	Positive integer	no	Transition day for calendar-based billing.
`autocalcday`	Flag	no	Automatic calculation of daily cost from monthly cost.
`chargestoped`	Flag	no	Charge funds when stopped. When disabled, client receives compensation for hours of downtime.
`quickorder`	Flag	no	Quick order. Enables service ordering without specifying parameters.
`access`	Positive integer	no	Access group. Select client group for which tariff is available for order.
`minperiodtype`	Positive integer	no	Minimum order period type.
`minperiodlen`	Positive integer	no	Minimum period length.
`trial`	Positive integer	no	Trial period length in days.
`trial_itemmax`	Positive integer	no	Maximum number of trial services per client.
`itemmax`	Positive integer	no	Maximum number of active services per client.
`suspendperiod`	Positive integer	no	Auto-deletion period (days).
`suspendpenaltytype`	Positive integer	no	Penalty type for overdue service renewal. Accepts the values: `0` — no penalty; `1` — fixed amount; `2` — percentage of overdue period cost; `3` — renewal from stop date.
`suspendpenaltypercent`	String	no	Percentage of service cost charged as penalty.
`changepolicy`	Positive integer	no	Tariff change policy. Accepts the values: `0` — change validity period; `1` — refund or charge difference; `2` — tariff change prohibited; `3` — charge only, no refund on downgrade; `4` — full payment for new tariff.
`changeprolongpolicy`	Positive integer	no	Policy for renewing service on a new tariff plan. Accepts the values: `0` — from current date; `1` — from service expiration date.
`orderpolicy`	Positive integer	no	Policy for ordering additional resources. Accepts the values: `0` — cost until service expiration; `1` — full period cost.
`returnpolicy`	Positive integer	no	Policy for refusing additional resources. Accepts the values: `0` — refund funds; `1` — no refund; `2` — change upon renewal.
`opennotify`	Positive integer	no	Service opening notification template. Accepts the value depending on configured templates.
`license`	Positive integer	no	Terms of service provision template. Accepts the value depending on configured templates.
`pricelist_group`	Positive integer	no	Tariff group. Accepts the value depending on configured groups.
`orderpriority`	Positive integer	no	Tariff priority during sorting (ascending).
`show_addon_image`	Flag	no	Show resource icons. Accepts the values: `no` — use product type settings; `off` — hide icons; `on` — show icons.
`description`	String	no	HTML description of the tariff plan.
`description_markdown`	String	no	Markdown description of the tariff plan.
`siteinfo`	String	no	Service information for integration with external site (showcase).
`label`	String	no	Tariff labels for filtering. Each label specified on a new line.
`allownosuitable`	Flag	no	Allow ordering when free resources are unavailable. Accepts the values `on` and `off`.
`nostopholidays`	Flag	no	Override service stop policy on weekends. Accepts the values: `no` — use product type settings; `off` — stop services; `on` — do not stop services.
`allowpostpaid`	Flag	no	Allow charging for resource overuse regardless of balance. Accepts the values `on` and `off`.
`restrictclientchange`	Flag	no	Defines if client can modify resource after ordering. Accepts the values `on` and `off`.
`create_addon`	Flag	no	Automatically create all available add-ons when creating tariff. Accepts the values `on` and `off`.
`sok`	String	yes	The value `ok` confirms operation execution.

Delete tariff plan

Function: pricelist.delete

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Delete.

Supports deletion of multiple tariff plans specified as a comma-separated list.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of tariff plans via comma. For example, `12,34,56`.
`sok`	String	yes	The value `ok` confirms operation execution.

Copy selected tariff

Function: pricelist.clone

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Clone.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	yes	`id` of tariff plan for copying.
`sok`	String	yes	The value `ok` confirms operation execution.

Import tariff from external server

Function: pricelist.import

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Import.

Loading tariff plan configuration from external server.

Access level: admin

Parameter	Type	Required	Value
`url`	String	yes	URL address of remote server for import.
`auth`	String	no	Authentication data on remote server.

Enable tariff plan

Function: pricelist.resume

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Enable.

Activates tariff plan for ordering. Supports batch operation.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of tariff plans via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Disable tariff plan

Function: pricelist.suspend

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Disable.

Deactivates tariff plan. Supports batch operation.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of tariff plans via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Tariff plan content

Function: pricelist.detail

Result: list of elements

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options.

Returns list of configurable add-ons (resources) linked to the tariff plan.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique identifier of the add-on.
`name`	String	no	Add-on name.
`price`	String	no	Add-on prices.
`orderpriority`	Positive integer	no	Add-on priority during sorting (ascending).
`status`	String (enumeration)	no	Add-on status.

Editing resource

Function: pricelist.detail.edit

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options → add-ons list → click Edit.

Allows viewing, modifying, or creating an object.

Access level: admin

Parameter	Type	Required	Value
`plid`	Positive integer	yes	Unique identifier of parent tariff plan.
`elid`	Positive integer	no	Unique identifier of add-on for editing.
`billtype`	Positive integer	no	Billing type. Method of charging client for the add-on. Accepts the values: `1` — do not bill; `2` — based on ordered values; `3` — based on statistics; `5` — based on other resource values.
`chargestoped`	Flag	no	When disabled, client receives compensation for hours of downtime of stopped service. Accepts the values `on` and `off`.
`itemtype`	Positive integer	no	Add-on type. Determines resource regulated by this add-on. Accepts value depending on platform settings.
`addontype`	Positive integer	no	Value type. Method of setting add-on value to tariff. Accepts value depending on platform settings.
`scaletype`	Positive integer	no	Value scale type. Parameter used for calculating add-on cost. Accepts the values: `0` — nearest value; `1` — per scale step; `2` — by value packages; `3` — by value options.
`restrictclientchange`	String (enumeration)	no	Client modification policy for resource after ordering. Accepts the values: `on` — modification not allowed; `off` — modification allowed; `uponly` — upgrade only; `downonly` — downgrade only.
`minperiodtype`	Positive integer	no	Minimum period after which client can decrease add-on.
`minperiodlen`	Positive integer	no	Minimum add-on order period duration.
`manualprocessing`	Flag	no	Task will be created for technical department to process resource. Accepts the values `on` and `off`.
`manualprocessing_skipdefault`	Flag	no	If this option is enabled and default value is selected for add-on, this add-on will not be added to manual processing task. Accepts the values `on` and `off`.
`manualname`	Flag	no	When enabled, add-on name will be taken from value specified in parameter `name`. Accepts the values `on` and `off`.
`name`	String	no	Name of tariff plan or add-on.
`intname`	String	no	Service name. Specified when it is necessary to override standard service name for add-on.
`processing_feature`	String	no	Check capability. When selecting add-on with specified capability, processing module with this capability will be selected.
`roundtype`	Positive integer	no	Method of rounding calculated value.
`addonstattype`	Positive integer	no	Select period for exceeding calculation.
`addonstatcomparison`	Positive integer	no	Select how to calculate if there are multiple parameters of same type. Accepts the values: `1` — sum; `2` — maximum value.
`addonstatcalculation`	Positive integer	no	Specify what price is indicated for. Accepts the values: `0` — per unit; `1` — per unit per month.
`addonstatchargestoped`	Flag	no	When enabled, charges for this add-on will continue even on stopped service. Accepts the values `on` and `off`.
`allowpostpaid`	Flag	no	Option allows charging for resource overuse regardless of client balance. Accepts the values `on` and `off`.
`summarizeinvoice`	Flag	no	Sum parameter value for entire period when generating act of performed works. Accepts the values `on` and `off`.
`measure`	Positive integer	no	Unit of measurement in which add-on is specified. Values depend on add-on type.
`addonlimit`	Positive integer	no	Included in tariff. Default value for add-on.
`addonstep`	Positive integer	no	Add-on order step.
`addonmin`	Positive integer	no	Minimum order value. Cannot be less than included in tariff.
`addonmax`	Positive integer	no	Maximum available order value for resource.
`addonlimittrial`	Positive integer	no	Included in tariff during trial period. Default value for add-on during trial period.
`addonmaxtrial`	Positive integer	no	Maximum available order value for resource during trial period.
`enumeration`	Positive integer	no	Enumeration from which values will be taken for service add-ons.
`enumerationitem`	Positive integer	no	Enumeration item included by default when ordering service.
`orderpolicy`	Positive integer	no	Cost on change. Determines how system calculates new cost after add-on modification.
`addonbool`	Flag	no	Default value for add-on. Accepts the values `on` and `off`.
`orderpriority`	Positive integer	no	Add-on priority during sorting (ascending).
`description`	String	no	HTML description of add-on.
`description_markdown`	String	no	Markdown description of add-on.
`sok`	String	yes	The value `ok` confirms operation execution.

Delete add-on

Function: pricelist.detail.delete

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options → select add-on → click Delete.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of add-ons via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Enable add-on

Function: pricelist.detail.resume

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options → select add-on → click Enable.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of add-ons via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Disable add-on

Function: pricelist.detail.suspend

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options → select add-on → click Disable.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of add-ons via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Move add-on up

Function: pricelist.detail.up

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options → select add-on → click Up.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	yes	`id` of add-on to move.

Move add-on down

Function: pricelist.detail.down

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options → select add-on → click Down.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	yes	`id` of add-on to move.

Add-on prices

Prices for different quantities

Function: pricelist.detail.integer

Result: list of elements

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options → select add-on → click Prices.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique identifier of price record.
`value`	Positive integer	no	Resource quantity.
`price`	String	no	Cost.

Special price

Function: pricelist.detail.integer.edit

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options → select add-on → click Prices → click Add or click Edit.

Allows viewing, modifying, or creating an object.

Access level: admin

Parameter	Type	Required	Value
`plid`	Positive integer	yes	Unique identifier of parent add-on (element `id` from function `pricelist.detail`).
`elid`	Positive integer	no	Unique identifier of price record (element `id` from function `pricelist.detail.integer`).
`value`	Positive integer	no	Resource quantity at which special price applies.
`sok`	String	yes	The value `ok` confirms operation execution.

Delete special price

Function: pricelist.detail.integer.delete

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options → select add-on → click Prices → click Delete.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of price records via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Prices (for add-ons with type "Enumeration")

Function: pricelist.detail.enum

Result: list of elements

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options → select add-on → click Prices.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique identifier of element.
`name`	String	no	Element name.
`price`	String	no	Element price.
`orderpriority`	Positive integer	no	Add-on priority during sorting (ascending).
`status`	String (enumeration)	no	Element status.

Enable enumeration element

Function: pricelist.detail.enum.resume

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options → select add-on → click Prices → select add-on → click Enable.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of elements via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Disable enumeration element

Function: pricelist.detail.enum.suspend

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options → select add-on → click Prices → select add-on → click Disable.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of elements via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Move enumeration element up

Function: pricelist.detail.enum.up

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options → select add-on → click Prices → select add-on → click Up.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	yes	`id` of enumeration element.

Move enumeration element down

Function: pricelist.detail.enum.down

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options → select add-on → click Prices → select add-on → click Down.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	yes	`id` of element to move.

Edit enumeration price

Function: pricelist.detail.enum.edit

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Options → select add-on → click Prices → select add-on → click Edit.

Managing cost and priority of enumeration elements.

Access level: admin

Parameter	Type	Required	Value
`plid`	Positive integer	yes	Unique identifier of parent add-on.
`elid`	Positive integer	no	Unique identifier of enumeration element.
`orderpriority`	Positive integer	no	Price priority during sorting (ascending).
`sok`	String	yes	The value `ok` confirms operation execution.

Resource variants

Function: pricelist.detail.compound

Result: list of elements

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique identifier of variant.
`name`	String	no	Variant name.
`price`	String	no	Variant prices.
`orderpriority`	Positive integer	no	Resource priority during sorting (ascending).
`status`	String (enumeration)	no	Variant status.

Move resource variant up

Function: pricelist.detail.compound.up

Result: successful operation execution or error message

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	yes	`id` of resource variant to move.

Move resource variant down

Function: pricelist.detail.compound.down

Result: successful operation execution or error message

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	yes	`id` of resource variant to move.

Dependency configuration

Function: pricelist.reference

Result: list of elements

In the platform web interface: section Products → Tariff plans → select tariff plan → click Dependencies.

Allows configuring dependency of one tariff plan add-on from another.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique identifier of dependency.
`referencedesc`	String	no	Dependency.
`reference`	String	no	Ratio.

Modifying dependency

Function: pricelist.reference.edit

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Dependencies → click Edit.

Configuring logic for automatic modification of dependent add-on values.

Access level: admin

Parameter	Type	Required	Value
`plid`	Positive integer	yes	Unique identifier of parent tariff plan.
`elid`	Positive integer	no	Unique identifier of dependency.
`pricelist_base`	Positive integer	no	Main tariff plan add-on. Dependent add-on value will be modified when this parameter changes.
`base_value`	String	no	Value of main add-on at which dependent add-on will be modified.
`enumerationitem_base`	Positive integer	no	Values, selection of one of which will modify dependent add-on.
`pricelist_reference`	Positive integer	no	Dependent add-on. Will be modified when main add-on changes.
`reference_value`	String	no	Value to be set for dependent add-on.
`enumerationitem_reference`	Positive integer	no	Values that will be available when modifying main add-on.
`sok`	String	yes	The value `ok` confirms operation execution.

Copy dependency

Function: pricelist.reference.clone

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Dependencies → click Copy.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	yes	`id` of dependency to clone.
`sok`	String	yes	The value `ok` confirms operation execution.

Delete dependency

Function: pricelist.reference.delete

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Dependencies → click Delete.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of dependencies via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Tariff change rules

Function: pricelist.change

Result: list of elements

In the platform web interface: section Products → Tariff plans → select tariff plan → click Change tariff.

Returns list of tariffs to which transition from current is possible.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique identifier of rule.
`name`	String	no	Rule name.
`status`	String (enumeration)	no	Rule status.

Enable change rule

Function: pricelist.change.resume

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Change tariff → select new tariff plan → click Enable.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of change rules via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Disable change rule

Function: pricelist.change.suspend

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Change tariff → select new tariff plan → click Disable.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of change rules via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Special tariff change rules

Function: pricelist.change.rule

Result: list of elements

In the platform web interface: section Products → Tariff plans → select tariff plan → click Change tariff → Rules section.

Returns list of special conditions for switching to another tariff.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique identifier of special rule.
`fromdate`	Date and time	no	Rule start date.
`todate`	Date and time	no	Rule end date.
`period`	String (enumeration)	no	Order period.
`discount`	Positive integer	no	Discount, %.

Special tariff change rule

Function: pricelist.change.rule.edit

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Change tariff → Rules section → click Add or Edit.

Configuring time frames, order periods, and discounts for transition.

Access level: admin

Parameter	Type	Required	Value
`plid`	Positive integer	yes	Unique identifier of parent tariff change rule.
`elid`	Positive integer	no	Unique identifier of special rule.
`fromdate`	Date and time	no	Start date of period during which rule applies to orders.
`todate`	Date and time	no	End date of period during which rule applies to orders.
`period`	String (enumeration)	no	Order period. Different rules can be configured for different order periods (lifetime, month, etc.).
`discount`	Positive integer	no	Discount size for new tariff in percent.
`sok`	String	yes	The value `ok` confirms operation execution.

Delete special rule

Function: pricelist.change.rule.delete

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Change tariff → Rules section → click Delete.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of special rules via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Tariff order rule configuration

Tariff order rules

Function: pricelist.orderreference

Result: list of elements

In the platform web interface: section Products → Tariff plans → select tariff plan → click Access.

Returns local order rules for the specific tariff.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique identifier of rule.
`name`	String	no	Rule name.
`status`	String (enumeration)	no	Rule status.

Enable order rule

Function: pricelist.orderreference.resume

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Access → select rule → click Enable.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of order rules via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Disable order rule

Function: pricelist.orderreference.suspend

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Access → select rule → click Disable.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of order rules via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Tariff order rules (product type)

Function: itemtype.orderreference

Result: list of elements

In the platform web interface: section Products → Tariff plans →select tariff plan → click Access → select rule → click Tariff plans.

Allows restricting ordering of selected tariff plan only to clients who already have active services of other tariffs.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique identifier of rule.
`name`	String	no	Rule name.
`status`	String (enumeration)	no	Rule status.

Enable access rule

Function: itemtype.orderreference.resume

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Access → select rule → click Tariff plans → select rule → click Enable.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of access rules via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Disable access rule

Function: itemtype.orderreference.suspend

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Access → select rule → click Tariff plans → select rule → click Disable.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of access rules via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Processing modules

Connecting to tariff plan processing modules

Function: pricelist.processing

Result: list of elements

In the platform web interface: section Products → Tariff plans → select tariff plan → click Modules.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique identifier of connection.
`name`	String	no	processing module name.
`orderpriority`	Positive integer	no	processing module priority during sorting (ascending).
`status`	String (enumeration)	no	processing module status.

Enable processing module

Function: pricelist.processing.resume

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Modules → select processing module → click Enable.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of connections via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Disable processing module

Function: pricelist.processing.suspend

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Modules → select processing module → click Disable.

Access level: admin

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of connections via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Move processing module up

Function: pricelist.processing.up

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Modules → select processing module → click Up.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	yes	`id` of connection to move.

Move processing module down

Function: pricelist.processing.down

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → select tariff plan → click Modules → select processing module → click Down.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	yes	`id` of connection to move.

Tariff plan change history

Function: pricelist.history

Result: list of elements

In the platform web interface: section Products → Tariff plans → select tariff plan → click History.

Returns a chronological history of changes to tariff plan parameters.

Access level: admin

Parameter	Type	Required	Value
`changedate`	Date and time	no	Change date.
`desc`	String	no	Change description.
`user`	String	no	User who made the change.
`ip`	String	no	IP address from which change was made.
`action`	String	no	Executed function.
`history_pricelist_tree`	String	no	Related objects: tariffs (`pl_`) or product types (`it_`). Format: `pl_12,it_456`.

Tariff archive

Parameter	Type	Required	Value
`elid`	String (list)	yes	One or several `id` of tariff plans for archiving via comma.
`sok`	String	yes	The value `ok` confirms operation execution.

Open tariff archive

Function: pricelist.archived

Result: list of elements

In the platform web interface: section Products → Tariff plans → click Archive.

Returns the list of tariff plans moved to archive.

Access level: admin

Parameter	Type	Required	Value
`id`	Positive integer	no	Unique identifier of archived tariff.
`name`	String	no	Archived tariff name.

Change tariff plan position in list

Move tariff plan up

Function: pricelist.up

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → click Up.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	yes	`id` of tariff plan to move.

Move tariff plan down

Function: pricelist.down

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → click Down.

Access level: admin

Parameter	Type	Required	Value
`elid`	Positive integer	yes	`id` of tariff plan to move.

Setting filter

Function: pricelist.filter

Result: successful operation execution or error message

In the platform web interface: section Products → Tariff plans → click Filter.

Saves the filter conditions applied each time the list is displayed until changed or reset.

Access level: admin

Parameter	Type	Required	Value
`name`	String	no	Search by tariff name. Wildcard character `*` is supported.
`itemtype_name`	String (enumeration)	no	Filter by service type.
`project`	Positive integer	no	Filter by provider.
`active`	Flag	no	Filter by status: `on` (active) or `off` (disabled).
`quickorder`	Flag	no	Filter by quick order availability.
`reset`	Flag	no	Value `on` resets all set filters.
`sok`	String	no	Value `ok` confirms filter saving.

Sync in progress flag reset

Function: pricelist.dropsyncinprogress

Result: successful operation execution or error message

Service function, not available in interface. Called via API or console.

Used to forcibly reset sync_in_progress parameter if tariff plan is "stuck" in synchronization state.

Access level: root, admin

Parameter	Type	Required	Value
`pricelist`	Positive integer	yes	`id` of tariff plan for which synchronization flag needs to be reset.