Conversion product object

A conversion product object describes an actual conversion product. In particular, its id is the product ID. It is possible to use the API to create/manage conversion product objects directly.

A conversion product object may have the following fields. If a field is not specified when the product is created, its value will be null. If a field is not specified in an update, this field's value will not be changed. If a field is missing when read back from the server (in the response to a create, read or update request), it means that its value is null.

Name	Type	Description
`id`	String	Identifier for the product.
`siteGroupId`	String	The site group identifier the product adheres to.
`siteId`	String	The site identifier the product adheres to.
`type`	Enum	The product type. One of 'subscription', 'newsletter' and 'registration'
`name`	String	The product name.
`renewalFrequency`	String	The product renewal frequency.
`deleted`	Boolean	`true` if the product is deleted.
`vxTermId`	String	Identifier for VX Term.
`vxTermType`	Enum	VX Term type corresponding to conversion product.

Notes

The renewal frequency has the format "<number><units><type>". If the renewal frequency is set on the product, the system will automatically renew all the conversions to this product every <number> of <units> until the conversion is explicitly stopped, renewed or started over. Only 'd' (days), 'w' (weeks), 'M' (months) and 'y' (years) are supported as <units>. The <type> can be one of 'R' (relative to the time the user has converted) or 'C' (calendar-based: happening at the beginning of the <unit>). Examples: "1yC", "28wR" and so on.
Possible values for VX Term type (defaults to 'NA'):

NA
PAYMENT
ADVIEW
REGISTRATION
NEWSLETTER
EXTERNAL
CUSTOM
GRANT_ACCESS
GIFT
SPECIFIC_EMAIL_ADDRESSES_CONTRACT
EMAIL_DOMAIN_CONTRACT
IP_RANGE_CONTRACT
DYNAMIC
LINK

Last updated: October 14, 2025