Name | Required | Description |
---|
digital | false | product has digital component |
physical | false | product has physical component |
digitalRecurring | false | product has digital recurring component |
physicalRecurring | false | product has physical recurring component |
categories | false | The categories for digital products. At least one is required for a product with a digital component, multiple may be specified. Must be either EBOOK, SOFTWARE, GAMES, AUDIO, VIDEO, or MEMBER_SITE. Providing a category for a product without a digital component will result in an error. |
skipConfirmationPage | false | Whether or not to skip confirmation page. This parameter is role restricted. If you do not have the role, it will not be honored. |
site | true | The site owning the product to be saved. |
thankYouPage | false | The thank you page for desktops. Either thankYouPage or mobileThankYouPage is required |
mobileThankYouPage | false | The thank you page for mobile devices. |
currency | true | The currency the product is sold in. |
price | true | The price for the product. Or in the case of RECURRING or RECURRING_PHYSICAL products, the initial price. |
rebillPrice | false | In the case of RECURRING or RECURRING_PHYSICAL (required) products the rebill price. |
rebillCommission | false | In the case of RECURRING or RECURRING_PHYSICAL products the rebill commission. |
trialPeriod | false | In the case of RECURRING or RECURRING_PHYSICAL (required) products the trial period. Must be either 0 or a whole number between 3 and 31. |
frequency | false | In the case of RECURRING or RECURRING_PHYSICAL (required) products the rebill frequency. Must be either WEEKLY, BI_WEEKLY, MONTHLY, QUARTERLY, HALF_YEARLY or YEARLY |
duration | false | In the case of RECURRING or RECURRING_PHYSICAL (required) products the rebill duration. |
shippingProfile | false | In the case of PHYSICAL or RECURRING_PHYSICAL products the name of the shipping profile |
purchaseCommission | false | The commission rate for the product - if unspecified the sites commission rate will be used. |
language | true | The language of the product. Must be either DE (German), EN (English), ES, (Spanish), FR (French), IT (Italian), or PT (Portuguese) |
title | true | The title of the product |
description | false | In the case of PHYSICAL or RECURRING_PHYSICAL (required) the description of the product. |
image | false | The id of the image associated to the product |
pitchPage | false | The URL where you pitch your product. This might be the same as the HopLink Target URL. Either pitchPage or mobilePitchPage is required. |
mobilePitchPage | false | The URL where you pitch your product to customers on mobile devices. This might be the same as the HopLink Target URL. Either pitchPage or mobilePitchPage is required. |
saleRefundDaysLimit | false | The number days within which a sale can be refunded |
rebillRefundDaysLimit | false | The number days within which a rebill can be refunded |
deliveryMethod | false | The method of delivery. |
deliverySpeed | false | The speed of delivery. |
preRebillNotificationOverride | false | When set, Pre-rebill notificaitons will be sent when the frequency is greater than the required cycle. |
preRebillNotificationLeadTime | false | The number of days before the rebill notification. When enabled, a Pre-rebill notification will be sent to the number equal to the number of days indicated in the lead time and will apply to the rest of the subscription. |