> For the complete documentation index, see [llms.txt](https://docs.2checkout.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.2checkout.com/api-reference/reference/partner-subscriptions.md).
# Partner subscriptions
## Calculate Partner Subscription Renewal Price
> Calculate the renewal price for partner subscriptions including discounts, margins, and pricing options.\
> This endpoint allows partners to get accurate pricing before placing a renewal order.
```json
{"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/channelmanager/subscriptions/renewalPrice":{"post":{"tags":["Partner subscriptions"],"summary":"Calculate Partner Subscription Renewal Price","description":"Calculate the renewal price for partner subscriptions including discounts, margins, and pricing options.\nThis endpoint allows partners to get accurate pricing before placing a renewal order.\n","operationId":"getPartnerSubscriptionsRenewalPrice","parameters":[{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","default":"application/json","enum":["application/json"]}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSubscriptionRenewalPriceRequest"}}}},"responses":{"200":{"description":"Renewal price calculated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSubscriptionPriceResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error"}}}}},"components":{"schemas":{"PartnerSubscriptionRenewalPriceRequest":{"type":"object","required":["Items"],"properties":{"Items":{"type":"array","description":"Array of subscription items to renew","items":{"$ref":"#/components/schemas/PartnerSubscriptionRenewalItem"}},"ExtraDiscount":{"$ref":"#/components/schemas/ExtraDiscountMargin"},"ExtraMargin":{"$ref":"#/components/schemas/ExtraDiscountMargin"}}},"PartnerSubscriptionRenewalItem":{"type":"object","required":["SubscriptionReference"],"properties":{"SubscriptionReference":{"type":"string","description":"Unique subscription reference"},"Quantity":{"type":"integer","description":"Quantity for renewal"},"PricingOptions":{"type":"array","description":"Pricing options for the subscription","items":{"$ref":"#/components/schemas/PricingOption"}}}},"PricingOption":{"type":"object","required":["Code"],"properties":{"Code":{"type":"string","description":"Pricing option code"}}},"ExtraDiscountMargin":{"type":"object","required":["Value","Type"],"properties":{"Value":{"type":"number","format":"float","description":"Value of the discount or margin"},"Type":{"type":"string","description":"Type of discount/margin","enum":["PERCENT","FIXED"]}}},"PartnerSubscriptionPriceResponse":{"type":"object","properties":{"Currency":{"type":"string","description":"Currency code"},"NetPrice":{"type":"number","format":"float","description":"Net price (excluding tax)"},"GrossPrice":{"type":"number","format":"float","description":"Gross price (including tax)"},"Vat":{"type":"number","format":"float","description":"VAT/tax amount"},"TotalDiscount":{"type":"number","format":"float","description":"Total discount amount"},"Discount":{"type":"number","format":"float","description":"Base discount amount"},"PartnerMargin":{"type":"number","format":"float","description":"Partner margin amount"},"ExtraMargin":{"type":"number","format":"float","description":"Extra margin applied"},"ExtraDiscount":{"type":"number","format":"float","description":"Extra discount applied"},"Items":{"type":"array","description":"Detailed pricing for each cart item","items":{"$ref":"#/components/schemas/PartnerSubscriptionCartItem"}}}},"PartnerSubscriptionCartItem":{"type":"object","properties":{"PurchaseType":{"type":"string","description":"Type of purchase (RENEWAL or UPGRADE)"},"PricingListCode":{"type":"string","description":"Pricing configuration code"},"SubscriptionReference":{"type":"string","description":"Subscription reference"},"Quantity":{"type":"integer","description":"Quantity"},"Prices":{"$ref":"#/components/schemas/PartnerSubscriptionCartItemPrices"},"Product":{"$ref":"#/components/schemas/PartnerSubscriptionCartProduct"},"ProductOptions":{"type":"array","description":"Product options selected","items":{"$ref":"#/components/schemas/PartnerSubscriptionProductOption"}},"Promotion":{"$ref":"#/components/schemas/PartnerSubscriptionCartPromotion"}}},"PartnerSubscriptionCartItemPrices":{"type":"object","description":"Detailed pricing breakdown for cart item","properties":{"NetPrice":{"type":"number","format":"float"},"GrossPrice":{"type":"number","format":"float"},"TotalDiscount":{"type":"number","format":"float"},"PartnerMargin":{"type":"number","format":"float"},"ExtraMargin":{"type":"number","format":"float"},"ExtraDiscount":{"type":"number","format":"float"},"Discount":{"type":"number","format":"float"},"CouponDiscount":{"type":"number","format":"float"},"Vat":{"type":"number","format":"float"},"UnitNetPrice":{"type":"number","format":"float"},"UnitGrossPrice":{"type":"number","format":"float"},"UnitTotalDiscount":{"type":"number","format":"float"},"UnitPartnerMargin":{"type":"number","format":"float"},"UnitExtraMargin":{"type":"number","format":"float"},"UnitExtraDiscount":{"type":"number","format":"float"},"UnitDiscount":{"type":"number","format":"float"},"UnitCouponDiscount":{"type":"number","format":"float"},"UnitVat":{"type":"number","format":"float"},"VatPercent":{"type":"number","format":"float"},"PartnerMarginPercent":{"type":"number","format":"float"}}},"PartnerSubscriptionCartProduct":{"type":"object","description":"Product information","properties":{"Name":{"type":"string"},"Code":{"type":"string"},"Version":{"type":"string"},"ShortDescription":{"type":"string"}}},"PartnerSubscriptionProductOption":{"type":"object","description":"Selected product option","properties":{"Code":{"type":"string"}}},"PartnerSubscriptionCartPromotion":{"type":"object","description":"Applied promotion information","properties":{"Name":{"type":"string"},"Code":{"type":"string"},"Coupon":{"type":"string"}}},"ErrorResponse":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}}
```
## Place Partner Subscription Renewal Order
> Place a renewal order for partner subscriptions. Returns the order reference number upon successful creation.
```json
{"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/channelmanager/subscriptions/placeRenewalOrder":{"post":{"tags":["Partner subscriptions"],"summary":"Place Partner Subscription Renewal Order","description":"Place a renewal order for partner subscriptions. Returns the order reference number upon successful creation.\n","operationId":"renewPartnerSubscriptions","parameters":[{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","default":"application/json","enum":["application/json"]}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSubscriptionRenewalOrderRequest"}}}},"responses":{"200":{"description":"Renewal order placed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSubscriptionOrderResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error"}}}}},"components":{"schemas":{"PartnerSubscriptionRenewalOrderRequest":{"type":"object","required":["Items"],"properties":{"Items":{"type":"array","description":"Array of subscription items to renew","items":{"$ref":"#/components/schemas/PartnerSubscriptionRenewalItem"}},"ExtraDiscount":{"$ref":"#/components/schemas/ExtraDiscountMargin"},"ExtraMargin":{"$ref":"#/components/schemas/ExtraDiscountMargin"},"ExternalReferenceNumber":{"type":"string","description":"External reference number for tracking"},"Comment":{"type":"string","description":"Comment to attach to the order"}}},"PartnerSubscriptionRenewalItem":{"type":"object","required":["SubscriptionReference"],"properties":{"SubscriptionReference":{"type":"string","description":"Unique subscription reference"},"Quantity":{"type":"integer","description":"Quantity for renewal"},"PricingOptions":{"type":"array","description":"Pricing options for the subscription","items":{"$ref":"#/components/schemas/PricingOption"}}}},"PricingOption":{"type":"object","required":["Code"],"properties":{"Code":{"type":"string","description":"Pricing option code"}}},"ExtraDiscountMargin":{"type":"object","required":["Value","Type"],"properties":{"Value":{"type":"number","format":"float","description":"Value of the discount or margin"},"Type":{"type":"string","description":"Type of discount/margin","enum":["PERCENT","FIXED"]}}},"PartnerSubscriptionOrderResponse":{"type":"object","description":"Order placement response","properties":{"RefNo":{"type":"integer","description":"Order reference number"},"Status":{"type":"string","description":"Order status"},"TotalAmount":{"type":"number","format":"float","description":"Total order amount"},"Currency":{"type":"string","description":"Currency code"}}},"ErrorResponse":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}}
```
## Calculate Partner Subscription Upgrade Price
> Calculate the upgrade price for partner subscriptions to a different product including price differentials, discounts, and margins.
```json
{"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/channelmanager/subscriptions/upgradePrice":{"post":{"tags":["Partner subscriptions"],"summary":"Calculate Partner Subscription Upgrade Price","description":"Calculate the upgrade price for partner subscriptions to a different product including price differentials, discounts, and margins.\n","operationId":"getPartnerSubscriptionsUpgradePrice","parameters":[{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","default":"application/json","enum":["application/json"]}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSubscriptionUpgradePriceRequest"}}}},"responses":{"200":{"description":"Upgrade price calculated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSubscriptionPriceResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error"}}}}},"components":{"schemas":{"PartnerSubscriptionUpgradePriceRequest":{"type":"object","required":["Items"],"properties":{"Items":{"type":"array","description":"Array of subscription items to upgrade","items":{"$ref":"#/components/schemas/PartnerSubscriptionUpgradeItem"}},"ExtraDiscount":{"$ref":"#/components/schemas/ExtraDiscountMargin"},"ExtraMargin":{"$ref":"#/components/schemas/ExtraDiscountMargin"}}},"PartnerSubscriptionUpgradeItem":{"type":"object","required":["SubscriptionReference","ProductCode"],"properties":{"SubscriptionReference":{"type":"string","description":"Unique subscription reference"},"ProductCode":{"type":"string","description":"Product code to upgrade to"},"Quantity":{"type":"integer","description":"Quantity for upgrade"},"PricingOptions":{"type":"array","description":"Pricing options for the upgraded product","items":{"$ref":"#/components/schemas/PricingOption"}}}},"PricingOption":{"type":"object","required":["Code"],"properties":{"Code":{"type":"string","description":"Pricing option code"}}},"ExtraDiscountMargin":{"type":"object","required":["Value","Type"],"properties":{"Value":{"type":"number","format":"float","description":"Value of the discount or margin"},"Type":{"type":"string","description":"Type of discount/margin","enum":["PERCENT","FIXED"]}}},"PartnerSubscriptionPriceResponse":{"type":"object","properties":{"Currency":{"type":"string","description":"Currency code"},"NetPrice":{"type":"number","format":"float","description":"Net price (excluding tax)"},"GrossPrice":{"type":"number","format":"float","description":"Gross price (including tax)"},"Vat":{"type":"number","format":"float","description":"VAT/tax amount"},"TotalDiscount":{"type":"number","format":"float","description":"Total discount amount"},"Discount":{"type":"number","format":"float","description":"Base discount amount"},"PartnerMargin":{"type":"number","format":"float","description":"Partner margin amount"},"ExtraMargin":{"type":"number","format":"float","description":"Extra margin applied"},"ExtraDiscount":{"type":"number","format":"float","description":"Extra discount applied"},"Items":{"type":"array","description":"Detailed pricing for each cart item","items":{"$ref":"#/components/schemas/PartnerSubscriptionCartItem"}}}},"PartnerSubscriptionCartItem":{"type":"object","properties":{"PurchaseType":{"type":"string","description":"Type of purchase (RENEWAL or UPGRADE)"},"PricingListCode":{"type":"string","description":"Pricing configuration code"},"SubscriptionReference":{"type":"string","description":"Subscription reference"},"Quantity":{"type":"integer","description":"Quantity"},"Prices":{"$ref":"#/components/schemas/PartnerSubscriptionCartItemPrices"},"Product":{"$ref":"#/components/schemas/PartnerSubscriptionCartProduct"},"ProductOptions":{"type":"array","description":"Product options selected","items":{"$ref":"#/components/schemas/PartnerSubscriptionProductOption"}},"Promotion":{"$ref":"#/components/schemas/PartnerSubscriptionCartPromotion"}}},"PartnerSubscriptionCartItemPrices":{"type":"object","description":"Detailed pricing breakdown for cart item","properties":{"NetPrice":{"type":"number","format":"float"},"GrossPrice":{"type":"number","format":"float"},"TotalDiscount":{"type":"number","format":"float"},"PartnerMargin":{"type":"number","format":"float"},"ExtraMargin":{"type":"number","format":"float"},"ExtraDiscount":{"type":"number","format":"float"},"Discount":{"type":"number","format":"float"},"CouponDiscount":{"type":"number","format":"float"},"Vat":{"type":"number","format":"float"},"UnitNetPrice":{"type":"number","format":"float"},"UnitGrossPrice":{"type":"number","format":"float"},"UnitTotalDiscount":{"type":"number","format":"float"},"UnitPartnerMargin":{"type":"number","format":"float"},"UnitExtraMargin":{"type":"number","format":"float"},"UnitExtraDiscount":{"type":"number","format":"float"},"UnitDiscount":{"type":"number","format":"float"},"UnitCouponDiscount":{"type":"number","format":"float"},"UnitVat":{"type":"number","format":"float"},"VatPercent":{"type":"number","format":"float"},"PartnerMarginPercent":{"type":"number","format":"float"}}},"PartnerSubscriptionCartProduct":{"type":"object","description":"Product information","properties":{"Name":{"type":"string"},"Code":{"type":"string"},"Version":{"type":"string"},"ShortDescription":{"type":"string"}}},"PartnerSubscriptionProductOption":{"type":"object","description":"Selected product option","properties":{"Code":{"type":"string"}}},"PartnerSubscriptionCartPromotion":{"type":"object","description":"Applied promotion information","properties":{"Name":{"type":"string"},"Code":{"type":"string"},"Coupon":{"type":"string"}}},"ErrorResponse":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}}
```
## Place Partner Subscription Upgrade Order
> Place an upgrade order for partner subscriptions to a different product. Returns the order reference number upon successful creation.
```json
{"openapi":"3.0.0","info":{"title":"API REST Documentation","version":"6.0-oas3"},"servers":[{"url":"https://api.2checkout.com/rest/6.0"}],"paths":{"/channelmanager/subscriptions/placeUpgradeOrder":{"post":{"tags":["Partner subscriptions"],"summary":"Place Partner Subscription Upgrade Order","description":"Place an upgrade order for partner subscriptions to a different product. Returns the order reference number upon successful creation.\n","operationId":"upgradePartnerSubscriptions","parameters":[{"name":"Accept","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string","default":"application/json","enum":["application/json"]}},{"name":"X-Avangate-Authentication","in":"header","description":"Authentication header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSubscriptionUpgradeOrderRequest"}}}},"responses":{"200":{"description":"Upgrade order placed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartnerSubscriptionOrderResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error"}}}}},"components":{"schemas":{"PartnerSubscriptionUpgradeOrderRequest":{"type":"object","required":["Items"],"properties":{"Items":{"type":"array","description":"Array of subscription items to upgrade","items":{"$ref":"#/components/schemas/PartnerSubscriptionUpgradeItem"}},"ExtraDiscount":{"$ref":"#/components/schemas/ExtraDiscountMargin"},"ExtraMargin":{"$ref":"#/components/schemas/ExtraDiscountMargin"},"ExternalReferenceNumber":{"type":"string","description":"External reference number for tracking"},"Comment":{"type":"string","description":"Comment to attach to the order"}}},"PartnerSubscriptionUpgradeItem":{"type":"object","required":["SubscriptionReference","ProductCode"],"properties":{"SubscriptionReference":{"type":"string","description":"Unique subscription reference"},"ProductCode":{"type":"string","description":"Product code to upgrade to"},"Quantity":{"type":"integer","description":"Quantity for upgrade"},"PricingOptions":{"type":"array","description":"Pricing options for the upgraded product","items":{"$ref":"#/components/schemas/PricingOption"}}}},"PricingOption":{"type":"object","required":["Code"],"properties":{"Code":{"type":"string","description":"Pricing option code"}}},"ExtraDiscountMargin":{"type":"object","required":["Value","Type"],"properties":{"Value":{"type":"number","format":"float","description":"Value of the discount or margin"},"Type":{"type":"string","description":"Type of discount/margin","enum":["PERCENT","FIXED"]}}},"PartnerSubscriptionOrderResponse":{"type":"object","description":"Order placement response","properties":{"RefNo":{"type":"integer","description":"Order reference number"},"Status":{"type":"string","description":"Order status"},"TotalAmount":{"type":"number","format":"float","description":"Total order amount"},"Currency":{"type":"string","description":"Currency code"}}},"ErrorResponse":{"type":"object","properties":{"error_code":{"type":"string"},"message":{"type":"string"}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## 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, and the optional `goal` query parameter:
```
GET https://docs.2checkout.com/api-reference/reference/partner-subscriptions.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
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.