Recurrence

Billing recurrence: its frequency and, in days, the timings of renewal, suspension and dismission

recurrence_idintegerrequired

frequency objectrequired

Frequency of a recurrence: a number of years, months or weeks, or a one-off charge

familystringrequired

Unit of the frequency: Y (years), M (months), W (weeks) or U (one-off, without renewals)

valueinteger | nullnullablerequired

Number of units of the frequency, for example 12 with M; null with U

days_renewinteger | nullnullablerequired

Days before the expiry from which the purchase can be renewed and the renewal order is created

days_autorenewinteger | nullnullablerequired

Days before the expiry when the automatic renewal is attempted

days_suspensioninteger | nullnullablerequired

Days after the expiry when a purchase not renewed is suspended; null if it is not suspended

days_restoreinteger | nullnullablerequired

Days after the expiry from which the restore price is charged in addition to the renewal price

days_dismissioninteger | nullnullablerequired

Days after the expiry when a purchase not renewed is dismissed

days_cancelinteger | nullnullablerequired

Days after the start of the activation when a purchase never activated is cancelled automatically

days_renew_dismissioninteger | nullnullablerequired

Days after the expiry when a purchase whose renewal was not completed is dismissed automatically

days_no_secondaryinteger | nullnullablerequired

Days before the expiry from which additional services can no longer be bought for the purchase

days_no_service_changeinteger | nullnullablerequired

Days before the expiry from which the service of the purchase can no longer be changed

Recurrence

{
  "recurrence_id": 0,
  "frequency": {
    "family": "string",
    "value": 0
  },
  "days_renew": 0,
  "days_autorenew": 0,
  "days_suspension": 0,
  "days_restore": 0,
  "days_dismission": 0,
  "days_cancel": 0,
  "days_renew_dismission": 0,
  "days_no_secondary": 0,
  "days_no_service_change": 0
}