Order session content

The object below is returned directly or within a successful response from the following API requests:

• Retrieve session content

• Retrieve contents with prefill

• Retrieve VAT or sales tax

Session contents object

Parameter	Type / Description
Errors	Array of strings Payment gateway processing errors.
Items	Array of objects Details below.
Items.ProductDetails	Object Details below.
Items.ProductDetails.Name	String Product name.
Items.ProductDetails.ShortDescription	String Product short description.
Items.ProductDetails.Tangible	Boolean Possible values: TRUE - for physical products FALSE - for digital products
Items.ProductDetails.IsDynamic	Boolean Possible values: TRUE - for dynamic products FALSE - for catalog products
Items.ProductDetails.ExtraInfo	String The text entered in the Additional information field when generating Buy links, or via the INFO[PRODUCT_ID] parameter used in Buy links.
Items.ProductDetails.RenewalStatus	Boolean TRUE for orders renewing subscriptions. FALSE for all other orders: new purchases, upgrades
Items.ProductDetails.Subscriptions	Object Details below.
Items.ProductDetails.Subscriptions.SubscriptionReference	String Unique, system-generated subscription identifier.
Items.ProductDetails.Subscriptions.PurchaseDate	String The date time stamp when shoppers acquired their subscriptions corresponding to the moment when the 2Checkout system marks the purchase as finished. Format (YYYY-MM-DD HH:mm:ss). Default GMT+02:00. e.g. 2015-08-11 15:18:52
Items.ProductDetails.Subscriptions.SubscriptionStartDate	String Example: 2015-09-29 17:57:59
Items.ProductDetails.Subscriptions.ExpirationDate	String The date time stamp of upcoming renewal/expiration for subscriptions not taking into account grace period settings. Format (YYYY-MM-DD HH:mm:ss). Default GMT+02:00. e.g. 2015-09-11 15:18:52
Items.ProductDetails.Subscriptions.Lifetime	Boolean TRUE – For non-recurring, evergreen subscriptions. FALSE– For recurring subscriptions with a specific billing cycle from 7 days to 36 months.
Items.ProductDetails.Subscriptions.Trial	Boolean TRUE – For trial subscriptions. FALSE– For non-trial, recurring subscriptions with a specific billing cycle from 7 days to 36 months.
Items.ProductDetails.Subscriptions.Enabled	Boolean TRUE – For active and past due subscriptions. FALSE– For expired and cancelled subscriptions.
Items.ProductDetails.Subscriptions.RecurringEnabled	Boolean TRUE - customers opted for subscriptions to renew automatically when they expire. FALSE- customers did not choose to renew the subscription automatically.
Items.ProductDetails.Subscriptions.BillingCycleLength	String The number of subscription billing cycle units (months or days). Possible values: -1 (-1 represents the one-time fee) Days 7 8 9 10 11 12 13 14 Months 1 2 3 6 12 15 18 24 36 (max)
Items.ProductDetails.Subscriptions.BillingCycleLengthUnit	String The units of the billing cycle: M - months D - days
Items.PriceOptions	Array of strings Product price options.
Items.Price	Object This object returns the price per unit at order line level. In the case of trials, the object returns the costs for the trial to full subscription conversion.
Items.Price.UnitNetPrice	Float The value per product unit, excluding sales tax/VAT expressed in the payment currency.
Items.Price.UnitGrossPrice	Float Total value per product unit, including sales tax/VAT expressed in the payment currency. UnitGrossPrice does not reflect any discounts.
Items.Price.UnitVAT	Int Sales tax/VAT per product unit expressed in the payment currency.
Items.Price.UnitDiscount	Int Value of the discount per product unit expressed in the payment currency.
Items.Price.UnitNetDiscountPrice	Float The value per product unit, expressed in the payment currency, excluding sales tax/VAT, from which 2Checkout deducts the unit discount.
Items.Price.UnitGrossDiscountPrice	Float Total costs shoppers incur per product unit, expressed in the payment currency. This value includes sales tax/VAT, 2Checkout and affiliate commissions, but 2Checkout deducts the value of any discounts.
Items.Price.UnitAffiliateCommision	Int Value of the affiliate commission per product unit calculated expressed in the payment currency. 2Checkout deducts discounts from the costs incurred by shoppers before calculating affiliate commissions. 2Checkout does not take into account shipping costs when calculating affiliate commissions. NULL when 2Checkout does not apply an affiliate commission.
Items.Price.VATPercent	Int Percentage of VAT charged on the order.
Items.Price.HandlingFeeNetPrice	Int Handling fee applied to your net price configuration.
Items.Price.HandlingFeeGrossPrice	Int Handling fee applied to your gross price configuration.
Items.Price.Currency	Optional (string) The currency ISO code for the payment - ISO 4217. Example: usd.
Items.Price.NetPrice	Optional (double) The value per order line, excluding sales tax/VAT expressed in the payment currency.
Items.Price.GrossPrice	Optional (double) Total value per order line, including sales tax/VAT expressed in the payment currency. UnitGrossPrice does not reflect any discounts.
Items.Price.NetDiscountPrice	Optional (double) The NetPrice value per order line, excluding sales tax/VAT, from which 2Checkout deducts discounts. NetDiscountedPrice is expressed in the payment currency.
Items.Price.GrossDiscountPrice	Optional (double) Total costs shoppers incur per order line, expressed in the payment currency. This value includes sales tax/VAT, 2Checkout and affiliate commissions, but 2Checkout deducts the value of any discounts. Example: UnitNetPrice: 99 UnitGrossPrice: 120.39 UnitVAT: 21.39 UnitDiscount: 9.9 UnitNetDiscountedPrice: 89.1 UnitGrossDiscountedPrice: 110.49 UnitAffiliateCommission: 22.28 Currency: "usd" NetPrice: 198 GrossPrice: 240.77 NetDiscountedPrice: 178.2 GrossDiscountedPrice: 220.97 Discount: 19.8 VAT: 42.77 AffiliateCommission: 44.56
Items.Price.Discount	Optional (double) Value of the discounts per order line expressed in the payment currency.
Items.Price.VAT	Optional (double) Value of sales tax/VAT per order line expressed in the payment currency.
Items.Price.AffiliateComission	Optional (double) Value of the affiliate commission per order line, calculated from the NetDiscountedPrice expressed in the payment currency. Or NULL. 2Checkout does not take into account shipping costs when calculating affiliate commissions.
Items.LineItemReference	String System-generated item reference.
Items.PurchaseType	String Possible values: PRODUCT SHIPPING TAX COUPON
Items.ExternalReference	String External order reference that you control.
Items.Code	String Unique product identifier your control. Max length 256 characters.
Items.Quantity	Int Number of units
Items.SKU	String SKU identifier.
Items.CrossSell	Object Details below.
Items.CrossSell.ParentCode	String The product code of the master product you set to trigger the campaign.
Items.CrossSell.CampaigCode	String Unique, system-generated identifier for cross-sell campaigns.
Items.Trial	Object Details below.
Items.Trial.Period	Int The length of the trial subscription lifetime in days.
Items.Trial.GrossPrice	Float Total trial price in the payment currency before 2Checkout deducts any taxes, discounts, etc.
Items.Trial.VAT	Float The total value of taxes for the trial in the payment currency, before 2Checkout deducts any discounts.
Items.Trial.NetPrice	Float Total trial price in the payment currency, not including taxes, before 2Checkout deducts any discounts.
Items.AdditionalFields	Array of objects Details below.
Items.AdditionalFields.Code	String The alpha-numeric characters, underscores and dashes that are set as the field identifier.
Items.AdditionalFields.Text	String Field text visible to shoppers in the cart.
Items.AdditionalFields.Value	String Selected field value.
Items.Promotion	Object Details below.
Items.Promotion.Name	String Promotion name.
Items.Promotion.Description	String Promotion description.
Items.Promotion.StartDate	String The date when you set the promotion to start. NULL for promotions that start immediately after you create them.
Items.Promotion.EndDate	String The date when you set the promotion to end. NULL for promotions you want active indefinitely.
Items.Promotion.MaximumOrdersNumber	Int 2Checkout only applies the promotion to a maximum number of orders you define. Can be NULL if you want the promotion to apply to an unlimited number of orders.
Items.Promotion.MaximumQuantity	Int Discount only applies to a maximum number of units purchased through a single order, smaller than the quantity you defined. Shoppers purchase any extra units at full price. Can be NULL if you want the promotion to apply to an unlimited number units.
Items.Promotion.InstantDiscount	Boolean The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon.
Items.Promotion.Coupon	String Promotion coupon/voucher.
Items.Promotion.DiscountLabel	String Discounts can be set as a percentage from the product price or as a fixed amount in the chosen currency.
Items.Promotion.Enabled	String true or false, depending on whether a promotion is active or disabled.
Items.Promotion.Type	String REGULAR – product/cart line level discounts. ORDER – quantity discounts. GLOBAL – order-level discounts.
Promotions	Array of objects Details below.
Promotions.Name	String Promotion name.
Promotions.Description	String Promotion description.
Promotions.StartDate	String The date when you set the promotion to start. NULL for promotions that start immediately after you create them.
Promotions.EndDate	String The date when you set the promotion to end. NULL for promotions you want active indefinitely.
Promotions.MaximumOrdersNumber	Int 2Checkout only applies the promotion to a maximum number of orders you define. Can be NULL if you want the promotion to apply to an unlimited number of orders.
Promotions.MaximumQuantity	Int Discount only applies to a specific number of units purchased at once, smaller than the maximum quantity you defined. Shoppers purchase any extra units at full price. Can be NULL if you want the promotion to apply to an unlimited number units.
Promotions.InstantDiscount	Boolean The instant discount option auto-applies the discount for ALL selected products, without the need for shoppers to enter a discount coupon.
Promotions.Coupon	String Promotion coupon/voucher.
Promotions.DiscountLabel	String Discounts can be set as a percentage from the product price or as a fixed amount in the payment currency.
Promotions.Enabled	String true or false, depending on whether a promotion is active or disabled.
Promotions.Type	String REGULAR – product/cart line level discounts. ORDER – quantity discounts. GLOBAL – order-level discounts.
AdditionalFields	Array of objects Details below.
AdditionalFields.Code	String The alpha-numeric characters, underscores and dashes that are set as the field identifier.
AdditionalFields.Text	String Field text visible to shoppers in the cart.
AdditionalFields.Value	String Selected field value.
BillingDetails	Object Details below
BillingDetails.person	Object Details below
BillingDetails.person.FirstName	String Customer first billing name.
BillingDetails.person.LastName	String Customer last billing name.
BillingDetails.person.CountryCode	String Two-letters code for customer billing country.
BillingDetails.person.State	String Customer billing state.
BillingDetails.person.City	String Customer billing city.
BillingDetails.person.Address1	String Customer billing address.
BillingDetails.person.Address2	String Customer additional address information.
BillingDetails.person.Zip	String Customer billing zip code.
BillingDetails.person.Email	String Customer billing email.
BillingDetails.person.Phone	String Customer billing phone.
BillingDetails.person.Company	String Customer billing company.
BillingDetails.person.FiscalCode	String Customer billing fiscal code.
DeliveryDetails	Object Details below
DeliveryDetails.Person	Object Details below
DeliveryDetails.Person.Phone	String Customer delivery phone number.
DeliveryDetails.Person.FirstName	String Customer delivery first name.
DeliveryDetails.Person.LastName	String Customer delivery last name.
DeliveryDetails.Person.Company	String Customer delivery company.
DeliveryDetails.Person.Email	String Customer delivery email.
DeliveryDetails.Person.Address1	String Customer delivery address.
DeliveryDetails.Person.Address2	String Customer additional delivery address.
DeliveryDetails.Person.City	String Customer delivery city.
DeliveryDetails.Person.Zip	String Customer delivery zip code.
DeliveryDetails.Person.CountryCode	String Customer delivery country code.
DeliveryDetails.Person.State	String Customer delivery state.
DeliveryInformation	Object Details below
DeliveryInformation.ShippingMethod	Object Details below
DeliveryInformation.ShippingMethod.Code	String System-generated code assigned to the shipping method.
DeliveryInformation.ShippingMethod.TrackingURL	String Tracking URL assigned to the shipping method.
DeliveryInformation.ShippingMethod.TrackingNumber	String Tracking Number provided to customers, used for obtaining more information about their package.
DeliveryInformation.ShippingMethod.Comment	String Additional information regarding the physical delivery of the product.
Currency	String The currency ISO code for the payment - ISO 4217. Example: usd.
NetPrice	Float Order value excluding sales tax/VAT expressed in the payment currency.
GrossPrice	Float Total order value, including sales tax/VAT expressed in the payment currency. GrossPrice does not reflect any discounts.
NetDiscountedPrice	Float The NetPrice order value excluding sales tax/VAT, from which 2Checkout deducts discounts. NetDiscountedPrice is expressed in the payment currency.
GrossDiscountedPrice	Float Total costs shoppers incur, expressed in the payment currency. This value includes sales tax/VAT, 2Checkout and affiliate commissions, but 2Checkout deducts the value of any discounts. For example: Currency: "usd" NetPrice: 396 GrossPrice: 486.29 NetDiscountedPrice: 376.2 GrossDiscountedPrice: 466.49 Discount: 19.8 VAT: 90.29 AffiliateCommission: 94.05
Discount	Float Value of the discounts for an order expressed in the payment currency.
VAT	Float Value of sales tax/VAT expressed in the payment currency.
AffiliateCommission	Float Value of the affiliate commission for the order calculated from the NetDiscountedPrice expressed in the payment currency. Or NULL. 2Checkout does not take into account shipping costs when calculating affiliate commissions.