Menu
Please select your pageSubscriptionAdded
This describes a message which is published when a new subscription is added through the API.
| Property | Type | Optional | Comment |
|---|---|---|---|
| CustomerNo | string(100) | No | CustomerNumber |
| BillingDayOffset | number(integer) | No | When an invoice is created for a subscription period, in relation to a subscription period start. If a period starts on the 1st of January and we have a billing day offset of 5, the invoice for that period will be created on the 6th of January i.e. (1+5). |
| Metadata | string | Yes | Metadata as provided by merchant |
| SubscriptionID | string (100) | No | The Id of the subscription as provided by the merchant |
| SubscriptionProductID | string (100) | No | The Id of the subscription product as provided by the merchant |
| SubscriptionProduct | object | No | See below |
Structure for Subscription Product Parameter
| Property | Type | Optional | Comment |
|---|---|---|---|
| Available | object | No | See below |
| Details | object | No | See below |
| PricePerPeriod | object | No | See below |
| TermsAndCondition | object | No | See below |
| Trial | object | No | See below |
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 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 PricePerPeriod Parameter
| Property | Type | Optional | Comment |
|---|---|---|---|
| CurrencyCode | string(3) | No | Name/description of the product |
| GrossAmount | decimal(18,4) | Yes | The hyperlink to the product image |
| VATPercentage | decimal(8,4) | Yes | The hyperlink to the product |
Structure for TermsAndCondition Parameter
| Property | Type | Optional | Comment |
|---|---|---|---|
| BillingFrequency | enum | No | Month = 0, Quarter = 1, HalfYear = 2, Year = 3 |
| BillingDayOffset | number(integer) | No | InAdvance = 0, InArrears = 1 |
| CancellationType | enum | No | Instant = 0, AfterCurrentPeriod = 1, AfterNextPeriod = 2 |
| Description | string | No | A short description of T&C, this is the contract description |
| 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 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. |