Pricing
Overview
Update subscription plan/product pricing using the PriceOptionsGroup and the PricingConfiguration objects.
PriceOptionsGroup
Use this object to add/create and edit/update price options for your account.
| Parameters | Type/Description | |||
|---|---|---|---|---|
|
PriceOptionsGroup |
Object |
|||
|
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 |
||
|
|
|
Product pricing options group name, localized under Options. |
||
|
|
Description |
String |
||
|
|
|
Product pricing options group description, localized 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 objects |
|||
|
|
Details below. |
|||
|
|
Name |
String |
||
|
|
|
Pricing option child name. |
||
|
|
Description |
String |
||
|
|
|
Pricing option child description. |
||
|
|
Translations |
Array of objects |
||
|
|
|
Details above. |
||
|
|
|
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 under PriceOptionGroup. Localized pricing option child description under Options. |
|
|
|
|
Language |
String |
|
|
|
|
|
ISO language code. (ISO 639-1 two-letter code). |
|
|
|
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 |
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 use PERCENT 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. |
||
|
Required |
boolean |
|||
|
|
True if you made the pricing option group mandatory. |
|||
PriceOptionGroup
Use this object to search for, retrieve information on price option groups (including those assigned to specific products) for your account.
| Parameters | Type/Description |
|---|---|
|
PriceOptionGroup |
Array of objects |
|
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. |
|
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. |
| Parameters | Type/Description |
|---|---|
|
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. |
|
PriceImpact |
Object |
|
|
Details below. |
|
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. |
| Parameters | Type/Description |
|---|---|
|
SubscriptionLifetimeImpact |
Object |
|
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 |
| Parameters | Type/Description |
|---|---|
|
PriceImpact |
Object |
|
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. |
| Parameters | Type/Description |
|---|---|
|
Amount |
Object |
|
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. |
| Parameters | Type/Description |
|---|---|
|
Translations |
Object |
|
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). |
PricingConfiguration
Use this object to add/create and update/edit pricing configurations for your account. You can assign one or multiple price option groups to pricing configurations.
You identify a pricing configuration using its unique identifier: Code.
| Parameters | Type/Description | |||
|---|---|---|---|---|
|
PricingConfiguration |
Object |
|||
|
Name |
String |
|||
|
|
Pricing configuration name. |
|||
|
Code |
String |
|||
|
|
System-generated identifier. Read-only. |
|||
|
Default |
Boolean |
|||
|
|
True for the default pricing configuration |
|||
|
BillingCountries |
Array of strings |
|||
|
|
ISO codes of the countries assigned to the pricing configuration. Empty unless a pricing configuration has specific countries assigned. |
|||
|
PricingSchema |
String |
|||
|
|
DYNAMIC – With a base price FLAT – Without a base price |
|||
|
PriceType |
String |
|||
|
|
Possible values: • NET • GROSS |
|||
|
DefaultCurrency |
String |
|||
|
|
The ISO code of the default currency for the pricing configuration |
|||
|
Prices |
Object |
|||
|
|
Details below. |
|||
|
|
Regular |
Array of objects |
||
|
|
|
Details below. |
||
|
|
|
Amount |
Int |
|
|
|
|
|
The price of the product. Use -1 to delete it. |
|
|
|
|
Currency |
String |
|
|
|
|
|
ISO code of the currency for the product price. |
|
|
|
|
MinQuantity |
Int |
|
|
|
|
|
The minimum quantity of volume discounts. Default is 1. |
|
|
|
|
MaxQuantity |
Int |
|
|
|
|
|
The maximum quantity of volume discounts. Default is 99999. |
|
|
|
|
OptionCodes |
Array of objects |
|
|
|
|
|
Details below. |
|
|
|
|
|
Code |
String |
|
|
|
|
|
System generated pricing options group code (you can also configure it) that the 2Checkout system uses to calculate product prices for pricing configurations without a base price. |
|
|
|
|
Options |
StringArray |
|
|
|
|
|
The pricing options group option code you configured that the 2Checkout system uses to calculate product prices for pricing configurations without a base price. |
|
|
Renewal |
Array of objects |
||
|
|
|
Details below. |
||
|
|
|
Amount |
Int |
|
|
|
|
|
The price of the product. Use -1 to delete it. |
|
|
|
|
Currency |
String |
|
|
|
|
|
ISO code of the currency for the product price. |
|
|
|
|
MinQuantity |
Int |
|
|
|
|
|
The minimum quantity of volume discounts. Default is 1. |
|
|
|
|
MaxQuantity |
Int |
|
|
|
|
|
The maximum quantity of volume discounts. Default is 99999. |
|
|
|
|
OptionCodes |
Array of objects |
|
|
|
|
|
Details below. |
|
|
PriceOptions |
Array of objects |
|||
|
|
Details below. |
|||
|
|
Code |
String |
||
|
|
|
System generated pricing options group code (you can also configure it) that the 2Checkout system uses to calculate product prices for pricing configurations without a base price. |
||
|
|
Required |
Boolean |
||
|
|
|
true – you set the price options group as required during the purchase process. false - you did not set the price options group as required during the purchase process. |
||
