# Upsell

Use the **UpSell** object in order to recommend products to customers via SOAP API 6.0.

Upselling is the practice that allows you to invite your customers to purchase a higher-end product, an upgrade, or an additional item in order to make a more profitable sale. The 2Checkout Public API supports upsell campaigns through which you can recommend catalog products to your shoppers.

## Request parameters <a href="#parameters" id="parameters"></a>

<table><thead><tr><th width="414.5999755859375">Parameter</th><th>Type / Description</th></tr></thead><tbody><tr><td><code>Name</code></td><td><strong>String</strong><br>Name of the upsell campaign.</td></tr><tr><td><code>StartDate</code></td><td><strong>String</strong><br>The date when the up-sell campaign starts, in the YYYY-MM-DD format. Can be NULL (starts immediately after enabling).</td></tr><tr><td><code>EndDate</code></td><td><strong>String</strong><br>The date when the up-sell campaign ends, in the YYYY-MM-DD format. Can be NULL (ends immediately after disabling).</td></tr><tr><td><code>DisplayForManualRenewals</code></td><td><strong>Boolean / integer</strong><br>Flag to control if the campaign will be displayed for manual subscription renewal orders. Can be set as true/false/0/1.</td></tr><tr><td><code>Discount</code></td><td><strong>Object</strong><br>Discount definition object, details below:</td></tr><tr><td><code>Discount.Type</code></td><td><strong>String</strong><br>Type of discount. Can be FIXED or PERCENT.</td></tr><tr><td><code>Discount.Value</code></td><td><strong>Integer</strong><br>Percentage discount value (PERCENT discount only).</td></tr><tr><td><code>Discount.Values</code></td><td><strong>Array of objects</strong><br>List of currency discounts (FIXED discount only), details below.</td></tr><tr><td><code>Discount.Values.Currency</code></td><td><strong>String</strong><br>Code of the currency for the related amount.</td></tr><tr><td><code>Discount.Values.Amount</code></td><td><strong>Integer</strong><br>Discount amount value for the related currency.</td></tr><tr><td><code>Discount.DefaultCurrency</code></td><td><strong>String</strong><br>Code of default currency (FIXED discount only).</td></tr><tr><td><code>PrimaryProduct</code></td><td><strong>Object</strong><br>Main (primary) product object, details below:</td></tr><tr><td><code>PrimaryProduct.Code</code></td><td><strong>String</strong><br>The code of the product that the recommendation is made for</td></tr><tr><td><code>PrimaryProduct.Quantity</code></td><td><strong>Integer</strong><br>The quantity for the primary product. Can be 0 (standing for any quantity)</td></tr><tr><td><code>PrimaryProduct.PriceOptions</code></td><td><strong>Array of objects</strong><br>Price options list for the primary product, details below:</td></tr><tr><td><code>PrimaryProduct.PriceOptions.Code</code></td><td><strong>String</strong><br>Price option group code.</td></tr><tr><td><code>PrimaryProduct.PriceOptions.Options</code></td><td><strong>Array of objects</strong><br>Price options list, details below:</td></tr><tr><td><code>PrimaryProduct.PriceOptions.Options.Code</code></td><td><strong>String</strong><br>Price option code.</td></tr><tr><td><code>PrimaryProduct.PriceOptions.Options.Value</code></td><td><strong>Integer</strong><br>Price option value (for scale interval price option group only).</td></tr><tr><td><code>RecommendedProduct</code></td><td><strong>Object</strong><br>Recommended product object, details below:</td></tr><tr><td><code>RecommendedProduct.Code</code></td><td><strong>String</strong><br>The code of the recommended product.</td></tr><tr><td><code>RecommendedProduct.Quantity</code></td><td><strong>Integer</strong><br>The quantity for the recommended product. Can be 0 (standing for “match quantity” setting).</td></tr><tr><td><code>RecommendedProduct.PriceOptions</code></td><td><strong>Array of objects</strong><br>Price options list for the recommended product, details below:</td></tr><tr><td><code>RecommendedProduct.PriceOptions.Code</code></td><td><strong>String</strong><br>Price option group code.</td></tr><tr><td><code>RecommendedProduct.PriceOptions.Options</code></td><td><strong>Array of objects</strong><br>Price options list, details below:</td></tr><tr><td><code>RecommendedProduct.PriceOptions.Options.Code</code></td><td><strong>String</strong><br>Price option code.</td></tr><tr><td><code>RecommendedProduct.PriceOptions.Options.Value</code></td><td><strong>Integer</strong><br>Price option value (for scale interval price option group only).</td></tr><tr><td><code>Enabled</code></td><td><strong>Boolean / integer</strong><br>Sets the campaign enabled or disabled. Can be set as true/false/0/1.</td></tr><tr><td><code>Description</code></td><td><strong>Array of objects</strong><br>List of campaign language descriptions, details below:</td></tr><tr><td><code>Description.Language</code></td><td><strong>String</strong><br>The language code.</td></tr><tr><td><code>Description.Text</code></td><td><strong>String</strong><br>The text of the description in the associated language.</td></tr><tr><td><code>UpsellingDisplayType</code></td><td><strong>String</strong><br>Set upsell settings display type. Can be overlay, interstitial.</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.2checkout.com/soap-api-reference/soap-api-6.0/api-requests/upsell.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.