Subscription upgrade

The object below is returned directly or within a successful response from the following API requests:

Retrieve options

Subscription upgrade object

Parameter
Type / Description

ProductInfo

Object Details below.

ProductInfo.ProductId

Int Unique, system-generated product identifier belonging to the upgrade product.

ProductInfo.ProductCode

String Unique product identifier that you control belonging to the upgrade product.

ProductInfo.ProductName

String Product name

ProductInfo.ProductVersion

String

The product version number that you control.

ProductInfo.ProductEnabled

Boolean Possible values:

0 – You disabled this product.

1 – You enabled this product.

ProductInfo.ProductType

String REGULAR or BUNDLE

ProductInfo.Currency

String The currency for prices. The currency ISO code used for the payment - ISO 4217.

ProductInfo.DefaultCurrency

String The product's default currency which is set in the Control Panel. The currency ISO code to be used for the payment - ISO 4217.

ProductInfo.Price

Double Product price. Can be null for flat pricing schemes. You need to call getPrice with Quantity, Currency and Price Options parameters to get a valid price.

ProductInfo.GiftOption

String True or false depending on whether the product can be gifted or not.

ProductInfo.IdGroup

Int Product Group ID number.

ProductInfo.GroupName

String The name of the Product Group.

ProductInfo.ShortDescription

String The product's short description.

ProductInfo.ProductImage

String URLs to the product images uploaded into the Avangate platform.

ProductInfo.Languages

Array of strings Array of ISO language codes for the product - ISO 639-1.

ProductInfo.PriceIntervals

Array of objects Pricing intervals.

ProductInfo.PriceTypea

String NET or GROSS

ProductInfo.PriceSchema

String FLAT or DYNAMIC

Quantity

Int Number of units available for the upgrade order.

PriceOptions

Array of objects Details below.

PriceOptions.Id

String Pricing options ID.

PriceOptions.Name

String Pricing options group name.

PriceOptions.Description

String The description of the Pricing options group

PriceOptions.Required

Boolean True or false depending on whether you set the Pricing options group as required or not.

PriceOptions.Type

String

Pricing options group type:

  • COMBO

  • CHECKBOX

  • RADIO

  • INTERVAL

PriceOptions.Options

Array of objects Details below.

PriceOptions.Options.Name

String The name of the option inside the Pricing options group

PriceOptions.Options.Value

String The code of the option inside the Pricing options group

PriceOptions.Options.Default

Boolean True or false.

PriceOptions.Options.Description

String The description of the option inside the Pricing options group.

PriceOptions.Options.MinValue

Int Start value of a scale interval.

PriceOptions.Options.MaxValue

Int End value of a scale interval.

Last updated

Was this helpful?