Pricing option
Overview
This object is returned directly or within a successful response from the following API requests:
Retrieve a price option group Retrieve assigned price option groups Retrieve price option groups
Pricing option group
| Parameters | Type/Description | |
|---|---|---|
|
Name |
String |
|
|
|
Price option group name.
Use this parameter when adding a new price options group.
To edit the name of a price option group use the Name parameter under the Translations object. |
|
|
Description |
String |
|
|
|
Pricing option group description. |
|
|
Translations |
Array of objects |
|
|
|
Details below. |
|
|
Name |
String |
|
|
|
Localized product pricing options group name under PriceOptionGroup. Localized pricing option child name under Options. |
|
|
Description |
String |
|
|
|
Localized product pricing options group description underPriceOptionGroup. Localized pricing option child description under Options. |
|
|
Language |
String |
|
|
|
ISO language code. (ISO 639-1 two-letter code). |
|
|
Code |
String |
|
|
|
Unique code that The 2Checkout system generates or set for each pricing options group. |
|
|
Type |
String |
|
|
|
The type of the pricing options group. Possible values: · RADIO · CHECKBOX · INTERVAL · COMBO |
|
|
Options |
Array of PriceOption objects |
|
|
|
Details below. |
|
|
PriceOption |
Object |
|
|
Code |
String |
|
|
|
The code you set or that the 2Checkout system generated for each pricing option child inside a pricing options group parent. |
|
|
ScaleMin |
Int |
|
|
|
The minimum value of a scale interval set for each pricing option child inside a pricing options group parent of the type INTERVAL. |
|
|
ScaleMax |
Int |
|
|
|
The maximum value of a scale interval set for each pricing option child inside a pricing options group parent of the type INTERVAL. |
|
|
SubscriptionImpact |
SubscriptionLifetimeImpact object |
|
|
|
Details below. |
|
|
Months |
String |
|
|
|
The value in months the 2Checkout system adds or subtracts from the initial billing cycle of a subscription. |
|
|
Impact |
String |
|
|
|
Possible values: · ADD · SUBTRACT · LIFETIME |
|
|
PriceImpact |
Object |
|
|
|
Details below. |
|
|
ImpactOn |
String |
|
|
|
Possible values:
|
|
|
Impact |
String |
|
|
|
Impact on price per unit:
|
|
|
Percent |
String |
|
|
|
The value of the percentage out of the price per product unit, when you usePERCENT for Method. |
|
|
Method |
String |
|
|
|
Possible values: · PERCENT · FIXED |
|
|
Amounts |
Array of objects. |
|
|
|
Details below. |
|
|
Currency |
String |
|
|
|
Currency ISO code - ISO 4217. |
|
|
Amount |
String |
|
|
|
The amount defined for each specific currency active for your account, when you use FIXED for Method. |
|
|
Default |
Boolean |
|
|
|
TRUE for preselected options. Missing for options that are not preselected. |
|
|
Name |
String |
|
|
|
Pricing option child name. |
|
|
Description |
String |
|
|
|
Pricing option child description. |
|
|
Translations |
Array of objects |
|
|
|
Details below. |
|
