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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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.
Export Pricelists
Function: pricelist.export
Result: data on tariff plans, their cost, addons, and parameters in JSON or XML format
Function is unavailable in the platform web interface. The platform uses this request to automatically export tariff information to the provider showcase. By default, the function can be called without authorization, so the showcase receives data without a login and password.
The function returns:
basic characteristics of the tariff plan: identifier, name, and description;
service cost for different payment periods and direct links for ordering;
renewal cost and setup fees, if specified in the tariff;
links for quick ordering via cart or payment, if this function is enabled;
trial period end date, if the tariff includes it;
data centers for service creation;
list of available addons and their parameters;
product type parameters for selection during checkout;
links to the provider privacy policy and user agreement.
Access level: without authorization, user, admin. If the PricelistsAccessOnlyRegistered option is enabled — user, admin.
The export composition depends on the access level:
without authorization — tariffs of a single provider. The platform determines the provider by the project parameter or request domain. The domain is compared with the Billing URL field in provider settings. If the provider is not determined, the function returns an empty list. Tariffs with restricted access by client groups are not included in the export;
user — tariffs of providers to which the client belongs. Tariffs with restricted access by client groups are exported considering the client's groups;
admin — tariffs of all platform providers or the provider from the elid parameter.
Parameter
Type
Required
Value
elid
Positive integer
no
Provider identifier in the platform. Not taken into account in requests without authorization.
project
Positive integer
no
Provider identifier for requests without authorization. If the parameter is not specified, the platform determines the provider by the request domain.
onlyavailable
Flag
no
The on value limits output to active tariffs available for ordering by the current user. Tariffs without a suitable processing module are not included in the output.
pricelist
String (list)
no
Tariff plan identifiers separated by commas. The platform will return data only for the specified tariffs.
itemtype
String
no
Product type identifier or internal name. For example, vds. The platform will return tariffs of this type only. Ignored if the pricelist parameter is specified.
exclude_pricelist
String (list)
no
Tariff plan identifiers separated by commas for exclusion from output.
addonitemtype
String (list)
no
Product type identifiers for addons separated by commas. The platform will output only addons of the specified types.
compound_child
Flag
no
The on value outputs addons included in a compound addon only within it. Without the flag, such addons are output in the general list of tariff addons as well.
othercurrency
String (list)
no
ISO currency codes separated by spaces. For example, USD EUR. The platform will recalculate prices to these currencies at the current rate. If the tariff already has a price in the specified currency, it is output without recalculation.
show_tax
Flag
no
The on value outputs the cost including tax and adds to the prices rate, amount, and tax accrual indicator on top of the price.
Add the line Option PricelistsAccessOnlyRegistered to the platform configuration file /usr/local/mgr5/etc/billmgr.conf;
Restart the platform:
/usr/local/mgr5/sbin/mgrctl -m billmgr exit.
After restart, the platform rejects requests without authorization. The option also disables the cost calculation function pricelist.calculate.
If the provider showcase exports tariffs via pricelist.export, after enabling the option it must pass authorization data in the request, for example, the authinfo parameter with the client login and password. In this case, the export considers the providers and groups of this client. Do not use the administrator account for the showcase.
Errors
if a non-existent tariff or a tariff of another provider is specified in the pricelist parameter, the platform returns an error in the pricelist parameter value;
if onlyavailable=on is specified, but the tariff from the pricelist parameter is inactive or unavailable for ordering, the platform returns an error;
if the client's service ordering is blocked due to debt, the function returns the error "You must first clear the debt".
Enable tariff plan
Function: pricelist.resume
Result: successful operation execution or error message
UI Equivalent: go to 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.
plid
String (list)
Yes
Unique identifier of parent processing.
sok
String
Yes
The value ok confirms operation execution.
Disable tariff plan
Function: pricelist.suspend
Result: successful operation execution or error message
UI Equivalent: go to Products → Tariff plans → select tariff plan → click Disable.
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to Products → Tariff plans → select tariff plan → click Options → select add-on → click Up.
Access level: admin
Parameter
Type
Required
Value
elid
Positive integer
Yes
idof add-on to move.
Move add-on down
Function: pricelist.detail.down
Result: successful operation execution or error message
UI Equivalent: go to Products → Tariff plans → select tariff plan → click Options → select add-on → click Down.
Access level: admin
Parameter
Type
Required
Value
elid
Positive integer
Yes
idof add-on to move.
Add-on prices
Prices for different quantities
Function: pricelist.detail.integer
Result: list of elements
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
Archive
Function: pricelist.archive
Result: successful operation execution or error message
UI Equivalent: go to Products → Tariff plans → click Archive.
Moves the selected tariffs to archive. Supports batch operation.
Access level: admin
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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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
UI Equivalent: go to 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.
En
Es