Q335: Can I set up automatic refunds of reservation payments as coupons when the reservation is being cancelled?

Note: refunds as coupon are not supported if you use the Shopping cart mode in your Planyo site.

This feature allows you to automatically refund payments made for a cancelled reservation as a coupon. The client can use the coupon for future bookings.
You can turn this on on the Active features page. In Refund reservation payments as coupon you can select for which type of cancellations the refund as coupon will be made:

Only when cancelled by administrator - here the refund as coupon will be made only when the reservation is cancelled by a site administrator, moderator or a resource administrator.
When cancelled by administrator or for automatic cancellations - the refund will be made additionally for automatic cancellations. Please note that cancellations made by API with the cancel action (see the do_reservation_action() API method) are treated as automatic cancellation in this feature.
All (including user and automatic cancellations) - here the refund will be made for all kind of cancellations, including those triggered by the client. API cancellations with the user_cancel action are considered user cancellations.

Optionally, you can limit the validation period of the coupon by entering the number of days in next field.

You can also set up a cancellation fee that will be deducted from the refunded amount. You can express it as a fixed amount (e.g. 10) or a percent of online payments made for the reservation (e.g. 5%).

Note that the reservation payments are not removed or cancelled. They remain listed on the reservation details page.

The coupon that will be created will follow the rules:

The refund is always made as a coupon of the Prepaid type.
The amount allocated to the coupon is equal to the net sum of payments made for the reservation (online payments minus any refunds). Note this amount can be father limited if you set up a cancellation fee.
Email address is required for creating the coupon. The refund will not work if no email address is specified in the reservation.
If a coupon of the type and for the email address doesn't already exist, a new one is created. On the other hand, if a matching coupon already exists and is still valid, its amount will be increased.
If you specify a limit for validity of the coupon, the validity starts on the day of the refund.
The coupon is not limited to any particular resource. It can be used for reservations of any resource in the site.
In case of multiple cancellations made to a reservation, the refunded amount is calculated according to the current setting concerning the cancellation fee (e.g. the percent rate) if one is used.
For multiple cancellations, the cancellation fee deducted only once (not each time a cancellation is made).

When sending one of the Reservation cancelled notification messages, you can use the $(refund_as_coupon_amount) tag to show any extra information about the coupon. Testing the tag allows you to tell if there was any refund as coupon made for the reservation. In such a case, you can instruct the client how they can use the coupon.

FAQ Q335: Can I set up automatic refunds of reservation payments as coupons when the reservation is being cancelled?