ChangeDeal

Change a deal license and create amendment order

post

Body

application/json

CurrencystringOptional

The deal order currency code

Example: usd

CountrystringOptional

The deal order country code

Example: us

LanguagestringOptional

The deal order language code

Example: en

CustomerIpstringOptional

The deal order customer IP

Example: 91.220.121.21

SourcestringOptional

The deal order source

Example: salesforce_cpq

Responses

200

Change deal success response

application/json

CurrencystringOptional

DealDueNowPriceNetnumberOptional

DealDueNowPriceGrossnumberOptional

DealTaxAmountnumberOptional

400

Change deal validation error

application/json

500

Change deal internal error

application/json

post

/subscriptions/deal/change/

HTTPcURLJavaScriptPython

POST /rest/6.0/subscriptions/deal/change/ HTTP/1.1
Host: api.2checkout.com
Content-Type: application/json
Accept: */*
Content-Length: 1590

{
  "Currency": "usd",
  "Country": "us",
  "Language": "en",
  "CustomerIp": "91.220.121.21",
  "Source": "salesforce_cpq",
  "Items": [
    {
      "DealDate": "2021-03-05 12:23:08",
      "SubscriptionReference": "3VS69GNF0C",
      "ProductCode": "PAV2019",
      "Quantity": 1,
      "DealPriceScenario": "using_last_order_price",
      "DealSubscriptionScenario": "prolong",
      "Price": {
        "Amount": 30,
        "Type": "CUSTOM",
        "AmountType": "GROSS"
      },
      "PriceOptions": [
        {
          "Code": "PO_GR1",
          "Options": [
            {
              "Value": "PO_GR1_O1"
            }
          ]
        }
      ],
      "SubscriptionCustomSettings": {
        "CycleLength": 1,
        "CycleUnit": "MONTH",
        "CycleAmount": 30,
        "CycleAmountType": "NET",
        "ContractLength": 12,
        "ClientDealAutoRenewal": true,
        "MerchantDealAutoRenewal": true
      }
    }
  ],
  "BillingDetails": {
    "FirstName": "Mark",
    "LastName": "Owen",
    "CountryCode": "us",
    "State": "Texas",
    "City": "Dallas",
    "Address1": "4519 BlueBridge Road",
    "Zip": "02199",
    "Email": "[e-mail]",
    "Phone": "6172938133",
    "Company": "Integra Wealth",
    "FiscalCode": "85421564"
  },
  "DeliveryDetails": {
    "FirstName": "Mark",
    "LastName": "Owen",
    "CountryCode": "us",
    "State": "Texas",
    "City": "Dallas",
    "Address1": "4519 BlueBridge Road",
    "Zip": "02199",
    "Email": "[e-mail]",
    "Phone": "6172938133",
    "Company": "Integra Wealth"
  },
  "PaymentDetails": {
    "Type": "EES_TOKEN_PAYMENT",
    "Currency": "usd",
    "CustomerIP": "91.220.121.21",
    "PaymentMethod": {
      "EesToken": "18998501-daa4-4bad-8699-5f29a1c56d6a",
      "RecurringEnabled": true
    }
  },
  "ExtraInformation": {
    "ProposalId": "1de36a0a-a7b6-4cb7-9de5-34c802e4243b",
    "PurchaseOrderDownloadLink": "https://secure.2checkout.com/proposal/po/342322/dl",
    "AssistedSaleAccountManagerEmail": "[e-mail]",
    "RetryFailedPaymentLink": "https://secure.2checkout.com/proposal/po/342322/retry?ref=[REFNO]"
  }
}

{
  "Items": [
    {
      "SubscriptionReference": "3VS69GNF0C",
      "DealPriceScenario": "using_last_order_price",
      "DealSubscriptionScenario": "prolong",
      "DealDate": "2021-03-05 12:23:08",
      "DealDueNowPriceNet": 30,
      "DealDueNowPriceGross": 31.875,
      "DealTaxAmount": 1.875,
      "DealTaxPercent": 6.25,
      "CurrentInfo": {
        "ProductCode": "BKG20193",
        "ProductName": "Backgammon 2019.3",
        "ProductDescription": "",
        "BillingPriceNet": 25,
        "BillingPriceGross": 26.5625,
        "NoOfBillingCycles": 13,
        "CurrentBillingCycle": 1,
        "PayedBillingCycles": 1,
        "RemainingBillingCycles": 11,
        "CurrentBillingCycleEndDate": "2021-02-18 13:26:51",
        "TaxAmount": 1.5625,
        "TaxPercent": 6.25,
        "BillingCyclesFrequency": 1,
        "BillingCycleFrequencyUnit": "MONTH",
        "ContractLength": 12,
        "ContractLengthUnit": "MONTH",
        "ProductOptions": [
          null
        ]
      },
      "NewDealInfo": {
        "ProductCode": "PAV2019",
        "ProductName": "Pipera AntiVirus 2019",
        "ProductDescription\"": "",
        "BillingPriceNet\"": 30,
        "BillingPriceGross": 31.875,
        "NoOfBillingCycles": 12,
        "CurrentBillingCycle": 1,
        "PayedBillingCycles": 0,
        "RemainingBillingCycles": 12,
        "CurrentBillingCycleEndDate": "2021-04-05 12:23:08",
        "TaxAmount": 1.875,
        "TaxPercent": 6.25,
        "BillingCyclesFrequency": 1,
        "BillingCycleFrequencyUnit": "MONTH",
        "ContractLength": 12,
        "ContractLengthUnit": "MONTH",
        "ProductOptions": [
          {
            "Code": "PO_GR1",
            "Options": [
              {
                "Value": "PO_GR1_O1"
              }
            ]
          }
        ]
      },
      "TotalsDealInfo": {
        "DealsNumber": 0,
        "ContractsNumber": 1,
        "PaidBillingCycles": 1,
        "ElapsedBillingCycles": 1
      }
    }
  ],
  "Currency": "usd",
  "DealDueNowPriceNet": 30,
  "DealDueNowPriceGross": 31.875,
  "DealTaxAmount": 1.875,
  "DealOrder": {
    "RefNo": 11832146,
    "ExternalReference": null,
    "Status": "AUTHRECEIVED",
    "ApproveStatus": "WAITING",
    "VendorApproveStatus": "OK",
    "MerchantCode": 120000589445,
    "Language": "en",
    "OrderDate": "2021-02-15 14:25:28",
    "FinishDate": null,
    "Source": null,
    "BillingDetails": {
      "FirstName": "Mark",
      "LastName": "Owen",
      "CountryCode": "us",
      "State": "Texas",
      "City": "Dallas",
      "Address1": "4519 BlueBridge Road",
      "Zip": "02199",
      "Email": "[e-mail]",
      "Phone": "6172938133",
      "Company": "Integra Wealth",
      "FiscalCode": "85421564"
    },
    "DeliveryDetails": {
      "FirstName": "Mark",
      "LastName": "Owen",
      "CountryCode": "us",
      "State": "Texas",
      "City": "Dallas",
      "Address1": "4519 BlueBridge Road",
      "Zip": "02199",
      "Email": "[e-mail]",
      "Phone": "6172938133",
      "Company": "Integra Wealth"
    },
    "PaymentDetails": {
      "Type": "CC",
      "Currency": "usd",
      "PaymentMethod": {
        "FirstDigits": 4111,
        "LastDigits": 1111,
        "CardType": "visa",
        "RecurringEnabled": true,
        "Vendor3DSReturnURL": null,
        "Vendor3DSCancelURL": null,
        "InstallmentsNumber": null
      }
    },
    "CustomerDetails": "null,",
    "Origin": "API",
    "AvangateCommission": 4.4,
    "OrderFlow": "REGULAR",
    "GiftDetails": null,
    "PODetails": null,
    "ExtraInformation": {
      "RetryFailedPaymentLink": "http://secure.avangate.local/proposal/po/342322/retry?ref=11827720",
      "ProposalId": "1de36a0a-a7b6-4cb7-9de5-34c802e4243b",
      "PurchaseOrderDownloadLink": "http://secure.avangate.local/proposal/po/342322/dl",
      "AssistedSale": true,
      "AssistedSaleAccountManagerEmail": "[e-mail]"
    },
    "Items": [
      {
        "ProductDetails": {
          "Name": "Pipera AntiVirus 2019",
          "ShortDescription": "",
          "Tangible": false,
          "IsDynamic": false,
          "RenewalStatus": false,
          "DeliveryInformation": {
            "Delivery": "NO_DELIVERY",
            "DownloadFile": null,
            "DeliveryDescription": "",
            "CodesDescription": "",
            "Codes": [
              null
            ]
          }
        },
        "PriceOptions": [
          null
        ],
        "Price": {
          "UnitNetPrice": 47.06,
          "UnitGrossPrice": 50,
          "UnitVAT": 2.94,
          "UnitDiscount": 0,
          "UnitNetDiscountedPrice": 47.06,
          "UnitGrossDiscountedPrice": 50,
          "UnitAffiliateCommission": 0,
          "ItemUnitNetPrice": null,
          "ItemUnitGrossPrice": null,
          "ItemNetPrice": null,
          "ItemGrossPrice": null,
          "VATPercent": 6.25,
          "HandlingFeeNetPrice": 0,
          "HandlingFeeGrossPrice": 0,
          "Currency": "usd",
          "NetPrice": 47.06,
          "GrossPrice": 50,
          "NetDiscountedPrice": 47.06,
          "GrossDiscountedPrice": 50,
          "Discount": 0,
          "VAT": 2.94,
          "AffiliateCommission": 0
        },
        "LineItemReference": "195253b498f70bd2ef652904793ef69bc119c80f",
        "PurchaseType": "PRODUCT",
        "Code": "PAV2019",
        "ExternalReference": "PAV2019QWE",
        "Quantity": 1,
        "SKU": null,
        "CrossSell": null,
        "Trial": null,
        "AdditionalFields": null,
        "Promotion": null,
        "RecurringOptions": null,
        "SubscriptionStartDate": null,
        "SubscriptionCustomSettings": {
          "CycleUnit": "MONTH",
          "CycleLength": 1,
          "CycleAmount": 50,
          "CycleAmountType": "GROSS",
          "ContractLength": 12,
          "MerchantDealAutoRenewal": true,
          "ClientDealAutoRenewal": true
        }
      }
    ],
    "Promotions": [
      null
    ],
    "AdditionalFields": null,
    "CustomParameters": null,
    "Currency": "usd",
    "NetPrice": 47.06,
    "GrossPrice": 50,
    "NetDiscountedPrice": 47.06,
    "GrossDiscountedPrice": 50,
    "Discount": 0,
    "VAT": 2.94,
    "AffiliateCommission": 0
  }
}