Pricing configuration
Last updated: 18-Feb-2025
Rate this article:
Overview
This object is returned directly or within a successful response from the following API requests:
- Retrieve a pricing configuration by name
- Retrieve a pricing configuration by code
- Retrieve pricing configurations
Pricing configuration object
| Parameters | Type/Description | |||
|---|---|---|---|---|
| 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. |
||||
Rate this article:
