Skip to main content

Recurring Interval

By setting up this property you configure how many times and when the subscription is renewed.

recurringInterval: {
unit: 'day', // 'day' | 'week' | 'month' | 'year' [in what time unit the subscription renewal should be calculated?]
length: 1, // [over how many unites?]
limit: 1, // [how many invoices should be generated? Set to 1 if you need only 1 invoice]
billingTiming: 'prepaid', // prepaid | postpaid
periodAnchorInstruction: {
method: 'immediately', // 'day-of-month' | 'day-of-week' | 'immediately'
}
}

For periodAnchorInstruction with day-of-month you specify also:

periodAnchorInstruction: {
method: 'day-of-month',
day: 1 // from 1 to 31
}

For periodAnchorInstruction with day-of-week you specify also:

periodAnchorInstruction: {
method: 'day-of-week',
day: 'Monday', // 'Sunday' | 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday'
week: 'next' // 'next' | 'first-in-month' | 'last-in-month'
}