Skip to main content
knowledgecenter.avangate.com

API Migration Guide

Overview

Use this guide to prepare and migrate your Avangate API implementation from version 1.0 to 3.0. This document features deprecations, updates and enhancements, providing guidance on how to upgrade your implementation to the latest version of the Avangate API. 

API 1.0 discontinuation

Avangate plans to discontinue API 1.0 as of the end of February 2017. The end-of-support date implies ceasing all development of bug fixes and patches for API 1.0. 

API 3.0 availability

Version 3.0 of the Avangate API is available as of June, 2016, following an extensive public testing phase started in November 2015. Avangate recommends that you migrate to the latest version of the API (v3.0) to enjoy support for your implementation.

API 3.0 what’s new and benefits

  1. Full REST support for existing platform functionalities in addition to SOAP and JSON-RPC.
  2. Simplify interactions with single-entry point (one endpoint, one client, single-authentication).
  3. Centralized all previous functionality under 3.0 (plus new capabilities).
  4. Unified WSDL for Order, Subscription and Product scenarios.

WSDL 1.0 vs. 3.0

When you migrate from API 1.0 to 3.0, stop using https://secure.avangate.com/api/merchant/?wsdl in favor of https://api.avangate.com/soap/3.0/?wsdl.

Methods 1.0 vs. 3.0

API 1.0

Status

API 3.0 equivalent

addLicense

Updated. Use:

addSubscription

addProduct

Deprecared

N/A. The placeOrder scenario now requires a single method.

clearProducts

Deprecared

N/A. The placeOrder scenario now requires a single method.

deleteProduct

Deprecared

N/A. The placeOrder scenario now requires a single method.

disableLicense

Updated. Use:

cancelSubscription

disableLicenseRecurring

Updated. Use:

disableRecurringBilling

enableLicense

Updated. Use:

enableSubscription

enableLicenseRecurring

Updated. Use:

enableRecurringBilling

extendLicense

Updated. Use:

extendSubscription

getAvailableCountries

Updated. Use:

getAvailableCountries

getAvailableCurrencies

Updated. Use:

getAvailableCurrencies

getAvailableLanguages

Updated. Use:

getAvailableLanguages

getContents

Updated. Use:

getContents

getInvoice

Updated. Use:

getInvoices

getLicense

Updated. Use:

getSubscription

getLicensePaymentDetails

Updated. Use:

getPaymentInformation

getLicenseProductUpgradeOptions

Updated. Use:

getProductUpgradeOptions

getNextRenewalPrice

Updated. Use:

getNextRenewalPrice

getOrder

Updated. Use:

getOrder

getOrderStatus

Updated. Use:

getOrder

getPrice

Updated. Use:

getPrice

getProductByCode

Updated. Use:

getProductByCode

getProductById

Updated. Use:

getProductByCode

getProductUpgradeOptionsPrice

Updated. Use:

getProductUpgradeOptionsPrice

getRenewalPrice

Updated. Use:

getRenewalDetails

getSingleSignOn

Updated. Use:

getSingleSignOn

getTimezone

Updated. Use:

getTimezone

isValidOrderReference

Updated. Use:

isValidOrderReference

login

Updated. Use:

login

placeOrder

Updated. Use:

placeOrder

renewLicense

Updated. Use:

renewSubscription

searchLicense

Updated. Use:

getSubscriptions

searchProducts

Updated. Use:

searchProducts

setBillingDetails

Deprecated.

N/A. The placeOrder scenario now requires a single method.

setClientIP

Deprecated.

N/A. The placeOrder scenario now requires a single method.

setCountry

Deprecated.

N/A. The placeOrder scenario now requires a single method.

setCurrency

Deprecated.

N/A. The placeOrder scenario now requires a single method.

setCustomer

Deprecated.

N/A. The placeOrder scenario now requires a single method.

setCustomRenewalPrice

Updated. Use:

setCustomRenewalPrice

setDeliveryDetails

Deprecated.

N/A. The placeOrder scenario now requires a single method.

setExternalRef

Deprecated.

N/A. The placeOrder scenario now requires a single method.

setLanguage

Deprecated.

N/A. The placeOrder scenario now requires a single method.

setLicenseEmailSubscription

Updated. Use:

setRenewalNotificationStatus

setLicenseUpgrade

Updated. Use:

setSubscriptionUpgrade

setPaymentDetails

Deprecated.

N/A. The placeOrder scenario now requires a single method.

setSource

Deprecated.

N/A. The placeOrder scenario now requires a single method.

setStaticPrice

Deprecated.

N/A. The placeOrder scenario now requires a single method.

updateLicense

Updated. Use:

updateSubscription

updateLicenseCustomer

Updated. Use:

updateSubscriptionEndUser

New use cases API 3.0 

SOAP

JSON-RPC

REST

Product

 

Enable/Disable products

 

Pricing

 

Save prices

 

Product group

 

Promotion

 

Order field

 

Cross-sell

 

Shipping class

 

Order object

 

1-click purchase


Orders with installments

 

Order session content object

 

Subscription import

 

Subscription

 

Next renewal price

 

Convert a trial

  

Subscription history

  

Customer

 

Copy payment info

 

Single Sign On (SSO)

Product

 

Enable/Disable products


Pricing

 

Save prices

 

Product group

 

Promotion


Order field

 

Cross-sell

Shipping class


Order object

 

1-click purchase


Orders with installments

 

Order session content object

 

Subscription import

 

Subscription

 

Next renewal price

 

Convert a trial

  

Subscription history

 

Customer

 

Copy payment info

 

Single Sign On (SSO)