Partner subscriptions

Calculate Partner Subscription Renewal Price

post

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.

Header parameters

Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Body

application/json

Responses

200

Renewal price calculated successfully

application/json

CurrencystringOptional

Currency code

Example: USD

NetPricenumber · floatOptional

Net price (excluding tax)

Example: 850

GrossPricenumber · floatOptional

Gross price (including tax)

Example: 1020

Vatnumber · floatOptional

VAT/tax amount

Example: 170

TotalDiscountnumber · floatOptional

Total discount amount

Example: 150

Discountnumber · floatOptional

Base discount amount

Example: 100

PartnerMarginnumber · floatOptional

Partner margin amount

Example: 200

ExtraMarginnumber · floatOptional

Extra margin applied

Example: 50

ExtraDiscountnumber · floatOptional

Extra discount applied

Example: 50

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

post

/channelmanager/subscriptions/renewalPrice

HTTPcURLJavaScriptPython

POST /rest/6.0/channelmanager/subscriptions/renewalPrice HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Content-Type: application/json
Content-Length: 212

{
  "Items": [
    {
      "SubscriptionReference": "SUB123456789",
      "Quantity": 5,
      "PricingOptions": [
        {
          "Code": "option1"
        },
        {
          "Code": "option2"
        }
      ]
    }
  ],
  "ExtraMargin": {
    "Value": 15,
    "Type": "PERCENT"
  },
  "ExtraDiscount": {
    "Value": 10,
    "Type": "PERCENT"
  }
}

{
  "Currency": "USD",
  "NetPrice": 850,
  "GrossPrice": 1020,
  "Vat": 170,
  "TotalDiscount": 150,
  "Discount": 100,
  "PartnerMargin": 200,
  "ExtraMargin": 50,
  "ExtraDiscount": 50,
  "Items": [
    {
      "PurchaseType": "RENEWAL",
      "PricingListCode": "STANDARD_PRICING",
      "SubscriptionReference": "SUB123456789",
      "Quantity": 5,
      "Prices": {
        "NetPrice": 850,
        "GrossPrice": 1020,
        "TotalDiscount": 150,
        "PartnerMargin": 200,
        "ExtraMargin": 50,
        "ExtraDiscount": 50,
        "Discount": 100,
        "CouponDiscount": 25,
        "Vat": 170,
        "UnitNetPrice": 170,
        "UnitGrossPrice": 204,
        "UnitTotalDiscount": 30,
        "UnitPartnerMargin": 40,
        "UnitExtraMargin": 10,
        "UnitExtraDiscount": 10,
        "UnitDiscount": 20,
        "UnitCouponDiscount": 5,
        "UnitVat": 34,
        "VatPercent": 20,
        "PartnerMarginPercent": 15
      },
      "Product": {
        "Name": "Enterprise Software Suite",
        "Code": "ENT_SOFT_001",
        "Version": "2.0",
        "ShortDescription": "Complete enterprise software solution"
      },
      "ProductOptions": [
        {
          "Code": "option1"
        }
      ],
      "Promotion": {
        "Name": "Spring 2024 Discount",
        "Code": "SPRING2024",
        "Coupon": "SAVE20NOW"
      }
    }
  ]
}

Place Partner Subscription Renewal Order

post

Place a renewal order for partner subscriptions. Returns the order reference number upon successful creation.

Header parameters

Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Body

application/json

ExternalReferenceNumberstringOptional

External reference number for tracking

Example: PO-2024-001

CommentstringOptional

Comment to attach to the order

Example: Annual renewal for enterprise customer

Responses

200

Renewal order placed successfully

application/json

Order placement response

RefNointegerOptional

Order reference number

Example: 987654321

StatusstringOptional

Order status

Example: PENDING

TotalAmountnumber · floatOptional

Total order amount

Example: 1020

CurrencystringOptional

Currency code

Example: USD

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

post

/channelmanager/subscriptions/placeRenewalOrder

HTTPcURLJavaScriptPython

POST /rest/6.0/channelmanager/subscriptions/placeRenewalOrder HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Content-Type: application/json
Content-Length: 303

{
  "Items": [
    {
      "SubscriptionReference": "SUB123456789",
      "Quantity": 5,
      "PricingOptions": [
        {
          "Code": "option1"
        },
        {
          "Code": "option2"
        }
      ]
    }
  ],
  "ExtraMargin": {
    "Value": 15,
    "Type": "PERCENT"
  },
  "ExtraDiscount": {
    "Value": 10,
    "Type": "PERCENT"
  },
  "ExternalReferenceNumber": "PO-2024-001",
  "Comment": "Annual renewal for enterprise customer"
}

{
  "RefNo": 987654321,
  "Status": "PENDING",
  "TotalAmount": 1020,
  "Currency": "USD"
}

Calculate Partner Subscription Upgrade Price

post

Calculate the upgrade price for partner subscriptions to a different product including price differentials, discounts, and margins.

Header parameters

Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Body

application/json

Responses

200

Upgrade price calculated successfully

application/json

CurrencystringOptional

Currency code

Example: USD

NetPricenumber · floatOptional

Net price (excluding tax)

Example: 850

GrossPricenumber · floatOptional

Gross price (including tax)

Example: 1020

Vatnumber · floatOptional

VAT/tax amount

Example: 170

TotalDiscountnumber · floatOptional

Total discount amount

Example: 150

Discountnumber · floatOptional

Base discount amount

Example: 100

PartnerMarginnumber · floatOptional

Partner margin amount

Example: 200

ExtraMarginnumber · floatOptional

Extra margin applied

Example: 50

ExtraDiscountnumber · floatOptional

Extra discount applied

Example: 50

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

post

/channelmanager/subscriptions/upgradePrice

HTTPcURLJavaScriptPython

POST /rest/6.0/channelmanager/subscriptions/upgradePrice HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Content-Type: application/json
Content-Length: 243

{
  "Items": [
    {
      "SubscriptionReference": "SUB123456789",
      "ProductCode": "ENTERPRISE_PLAN",
      "Quantity": 5,
      "PricingOptions": [
        {
          "Code": "option1"
        },
        {
          "Code": "option2"
        }
      ]
    }
  ],
  "ExtraMargin": {
    "Value": 15,
    "Type": "PERCENT"
  },
  "ExtraDiscount": {
    "Value": 5,
    "Type": "PERCENT"
  }
}

{
  "Currency": "USD",
  "NetPrice": 850,
  "GrossPrice": 1020,
  "Vat": 170,
  "TotalDiscount": 150,
  "Discount": 100,
  "PartnerMargin": 200,
  "ExtraMargin": 50,
  "ExtraDiscount": 50,
  "Items": [
    {
      "PurchaseType": "RENEWAL",
      "PricingListCode": "STANDARD_PRICING",
      "SubscriptionReference": "SUB123456789",
      "Quantity": 5,
      "Prices": {
        "NetPrice": 850,
        "GrossPrice": 1020,
        "TotalDiscount": 150,
        "PartnerMargin": 200,
        "ExtraMargin": 50,
        "ExtraDiscount": 50,
        "Discount": 100,
        "CouponDiscount": 25,
        "Vat": 170,
        "UnitNetPrice": 170,
        "UnitGrossPrice": 204,
        "UnitTotalDiscount": 30,
        "UnitPartnerMargin": 40,
        "UnitExtraMargin": 10,
        "UnitExtraDiscount": 10,
        "UnitDiscount": 20,
        "UnitCouponDiscount": 5,
        "UnitVat": 34,
        "VatPercent": 20,
        "PartnerMarginPercent": 15
      },
      "Product": {
        "Name": "Enterprise Software Suite",
        "Code": "ENT_SOFT_001",
        "Version": "2.0",
        "ShortDescription": "Complete enterprise software solution"
      },
      "ProductOptions": [
        {
          "Code": "option1"
        }
      ],
      "Promotion": {
        "Name": "Spring 2024 Discount",
        "Code": "SPRING2024",
        "Coupon": "SAVE20NOW"
      }
    }
  ]
}

Place Partner Subscription Upgrade Order

post

Place an upgrade order for partner subscriptions to a different product. Returns the order reference number upon successful creation.

Header parameters

Acceptstring · enumRequiredDefault: application/jsonExample: application/jsonPossible values:

X-Avangate-AuthenticationstringRequired

Authentication header

Example: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"

Body

application/json

ExternalReferenceNumberstringOptional

External reference number for tracking

Example: UPG-2024-001

CommentstringOptional

Comment to attach to the order

Example: Upgrade to enterprise plan

Responses

200

Upgrade order placed successfully

application/json

Order placement response

RefNointegerOptional

Order reference number

Example: 987654321

StatusstringOptional

Order status

Example: PENDING

TotalAmountnumber · floatOptional

Total order amount

Example: 1020

CurrencystringOptional

Currency code

Example: USD

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

post

/channelmanager/subscriptions/placeUpgradeOrder

HTTPcURLJavaScriptPython

POST /rest/6.0/channelmanager/subscriptions/placeUpgradeOrder HTTP/1.1
Host: api.2checkout.com
Accept: application/json
X-Avangate-Authentication: code="{VENDOR_CODE}" date="{REQUEST_DATE_TIME}" hash="{HASH}"
Content-Type: application/json
Content-Length: 323

{
  "Items": [
    {
      "SubscriptionReference": "SUB123456789",
      "ProductCode": "ENTERPRISE_PLAN",
      "Quantity": 5,
      "PricingOptions": [
        {
          "Code": "option1"
        },
        {
          "Code": "option2"
        }
      ]
    }
  ],
  "ExtraMargin": {
    "Value": 15,
    "Type": "PERCENT"
  },
  "ExtraDiscount": {
    "Value": 5,
    "Type": "PERCENT"
  },
  "ExternalReferenceNumber": "UPG-2024-001",
  "Comment": "Upgrade to enterprise plan"
}

{
  "RefNo": 987654321,
  "Status": "PENDING",
  "TotalAmount": 1020,
  "Currency": "USD"
}