SubscriptionProductAdded

This describes a message which is published when a new subscription product is added through the API.

Property Type Optional Comment
Details string No This refers to the subscription product ID
Period string No Describes a period for the subscription product
Items string No This refers to the product items. There can be multiple items for a product. More details below
TermsAndConditions string No Terms and conditions for the product. More details below
Available string No Validity period of the subscription product. More details below
Trial string No This refers to whether the product has a trial or not. More details below
FinancingType string No This describes the financing type for the product

Structure for Details Parameter

Property Type Optional Comment
Description string(200) No Name/description of the product
ImageURL string(1000) Yes The hyperlink to the product image
ProductURL string(1000) Yes The hyperlink to the product

Structure for Items Parameter

Property Type Optional Comment
Name string No Name of the item
Description string Yes Description of the item
GrossAmount decimal(18,4) No The gross amount of the item
VATPercentage decimal(8,4) No The VAT amount of the item (%)
Metadata string Yes Additional Data about the item
isRefundable boolean Yes Stating whether the item is refundable or not

Structure for TermsAndCondition Parameter

Property Type Optional Comment
Description string No A short description of T&C, this is the contract description
BillingType string No InAdvance = 0, InArrears = 1
BillingDayOffset number(integer) No
CancellationType enum No Instant = 0, AfterCurrentPeriod = 1, AfterNextPeriod = 2
CancellationGraceDays integer Yes
NumberOfCommitmentPeriods integer No Number of periods in a commitment cycle
NumberOfCommitmentCycles integer Yes Number of commitment cycles
EndOfCommitmentAction enum No RenewCommitment = 0, ConsinueWithoutCommitment = 1, CloseSubscription = 2

Structure for Available Parameter

Property Type Optional Comment
From Datetime No Defines the period in time the product is available
Until Datetime No Defines the period in time the product is available

Structure for Trial Parameter

Property Type Optional Comment
Description string (200) No Description of Trial Period
TrialLength enum No Two weeks = 0, One month = 1
GrossAmount decimal (18,4) No The Price for the trial
VatPercentage decimal (18,4) No The vat percentage included in the gross amount.