Override types
An override temporarily changes an aspect on the customer or on a subscription for the customer, e.g. the delivery address, or suspends delivery. This is used to represent vacations, scheduled future changes and internally also suspensions due to missing payments.
The concept is useful if the modification is only temporary or in the future, otherwise you'd just change the customer or subscription directly.
Scheduled future changes are applied automatically by Iteras when their time comes.
Available override types
| Name | Description |
|---|---|
| Pause subscription (subscription) pause-subscription |
Pause the whole subscription for a period. subscription_id, begin and end define the period, and pause_reason optionally the reason, e.g. "Vacation". |
| Pause deliveries (subscription) pause-delivery |
Pause the deliveries of an otherwise running subscription. subscription_id, begin and end define the interval the deliveries are paused. |
| Pause deliveries and donate (subscription) pause-delivery-donate |
Pause the deliveries and donate the value of the issues instead. subscription_id, begin and end define the interval the deliveries are paused and donated. |
| Send to another address (subscription) alternative-delivery |
Send the subscription to another address. subscription_id, begin and end define the interval the subscription is sent to address, and weekdays optionally restricts it to some days for weekdays-based distribution. |
| Future change of fields (customer or subscription) change-fields |
Change one or more customer or subscription fields at a future date. begin is when the change takes effect and new_values the fields to change. The change applies to the customer unless a subscription_id is given. |
| Future change of delivery address (customer or subscription) change-delivery-address |
Change the delivery address at a future date. begin is when the new address takes effect and address the new address. |
| Future change of billing address (customer or subscription) change-billing-address |
Change the billing address at a future date. begin is when the new address takes effect and address the new address. |
A future address change on a subscription only works if subscriptions have been set up to have an address field for the relevant address type.