This is where you'll find the technical specification for the Recurrence Object. The Recurrence Object defines the structure required to set up recurring payment mandates wth the Trustly API. The following table lists the necessary fields, including the start and end dates, payment frequency parameters (frequency, frequencyUnit, frequencyUnitType), and the automaticCapture flag. You can use the Recurrence Object to integrate subscription models, installment plans, and scheduled billing accurately.
| Parameter | Type | Description |
|---|---|---|
| startDate | Unix Timestamp | Recurring payment start date. |
| endDate | Unix Timestamp | Recurring payment end date. |
| nextOccurrence | Unix Timestamp | When the next capture will be issued if using automatic captures. |
| recurringAmount | String | Recurring payment amount. (maximum of 10 characters with support for 2 decimal places) |
| debtSettlement | String | Any debt amount settlement done outside of Trustly like discounts or when consumers pay one recurring debt using another payment method like traditional checks or credit cards. (maximum of 10 characters with support for 2 decimal places) |
| frequency | Number | How many payments per frequencyUnit. Defaults to 1. Example: To define 2 recurring payments every 3 months set: frequency = 2, frequencyUnit = 3 and frequencyUnitType = "Month". |
| frequencyUnit | Number | Along with frequencyUnitType, defines the interval of the frequency of payments. |
| frequencyUnitType | String | Valid values are as follows: Day, Week, Month, or Year. |
| automaticCapture | Boolean | If true, payment captures are issued automatically. |