CaptainBook.io

The Cancel Booking action cancels a booking with optional refund processing and notification settings. Use this to automate booking cancellations based on business rules or external events.

___________________________________________________________

The ID of the booking to cancel. Supports variables.

How to handle refunds for the cancelled booking:

<code>PARTIAL</code> - Partial refund (requires refund amount)

<code>FULL</code> - Full refund of all paid amounts

- <code>NONE</code> - No refund (default)
- <code>PARTIAL</code> - Partial refund (requires refund amount)
- <code>FULL</code> - Full refund of all paid amounts

Refund Amount (Required if Refund Mode is PARTIAL)

The amount to refund. Can be specified as:

Percentage (e.g., <code>50</code> for 50%)

- Flat amount (e.g., <code>100.00</code>)
- Percentage (e.g., <code>50</code> for 50%)

Refund Amount Type (Required if Refund Mode is PARTIAL)

<code>percentage</code> - Percentage of total paid

- <code>flat</code> - Fixed amount
- <code>percentage</code> - Percentage of total paid

Reason for cancellation. Supports variables.

Detailed explanation for cancellation. Supports variables.

Whether to notify administrators (default: <code>true</code>). Supports variables.

Whether to notify the customer (default: <code>true</code>). Supports variables.

Returns the cancelled booking object in the workflow context with updated cancellation information.

{booking.id} {booking.cancelled_at} {booking.cancelled_reason} {booking.cancelled_reason_details}

Booking ID: {booking.id} Refund Mode: NONE Notify Customer: true

Booking ID: {booking.id} Refund Mode: FULL Notify Customer: true Notify Admins: true

Booking ID: {booking.id} Refund Mode: PARTIAL Refund Amount: 50 Refund Amount Type: percentage Reason: Customer requested partial refund

Booking ID: {booking.id} Refund Mode: PARTIAL Refund Amount: 250.00 Refund Amount Type: flat Reason: Service disruption Reason Details: Weather conditions prevented service delivery

Refunds all paid amounts across all booking transactions

Automatically distributes refund across transactions

- Refunds all paid amounts across all booking transactions
- Automatically distributes refund across transactions

Refund amount cannot exceed total amount charged

Automatically distributes refund across booking transactions

Supports both flat amounts and percentages

- Refund amount cannot exceed total amount charged
- Automatically distributes refund across booking transactions
- Supports both flat amounts and percentages

Verify booking exists - Check booking ID before cancelling

Check booking status - Ensure booking is not already cancelled

Handle refunds carefully - Verify refund amounts are correct

Notify appropriately - Set notification preferences based on context

Log cancellation reasons - Always provide reason for tracking

Test refund logic - Test partial refund calculations thoroughly

1. Verify booking exists - Check booking ID before cancelling
2. Check booking status - Ensure booking is not already cancelled
3. Handle refunds carefully - Verify refund amounts are correct
4. Notify appropriately - Set notification preferences based on context
5. Log cancellation reasons - Always provide reason for tracking
6. Test refund logic - Test partial refund calculations thoroughly

<a href="https://knowledge.captainbook.io/en/articles/13229918-get-booking-action">Get Booking Action</a>

<a href="https://knowledge.captainbook.io/en/articles/13229925-update-booking-action">Update Booking Action</a>

<a href="https://knowledge.captainbook.io/en/articles/13229886-create-booking-action">Create Booking Action</a>

- <a href="https://knowledge.captainbook.io/en/articles/13229918-get-booking-action">Get Booking Action</a>
- <a href="https://knowledge.captainbook.io/en/articles/13229925-update-booking-action">Update Booking Action</a>
- <a href="https://knowledge.captainbook.io/en/articles/13229886-create-booking-action">Create Booking Action</a>

The Cancel Booking action cancels a booking with optional refund processing and notification settings. Use this to automate booking cancellations based on business rules or external events.

Cancel Booking Action

Find answers and get help from Intercom Support and Community Experts

This site employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

Advertising cookies are set by our advertising partners to collect information about your use of the site, our communications, and other online services over time and with different browsers and devices. They use this information to show you ads online that they think will interest you and measure the ads' performance. Social media cookies are set by social media platforms to enable you to share content on those platforms, and are capable of tracking information about your activity across other online services for use as described in their privacy policies.

These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

These cookies are necessary for the website to function and cannot be switched off in our systems.

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

Cookie Settings

Link, Press control-option-right-arrow to exit

Empty Help Center

Uh oh. That page doesn’t exist.

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.

Cancel Booking Action

Overview

Configuration

Booking ID (Required)

Refund Mode (Optional)

Refund Amount (Required if Refund Mode is PARTIAL)

Refund Amount Type (Required if Refund Mode is PARTIAL)

Cancellation Reason (Optional)

Cancellation Reason Details (Optional)

Notify Admins (Optional)

Notify Customer (Optional)

Output

Accessing Booking Data

Examples

1. Simple Cancellation (No Refund)

2. Cancellation with Full Refund

3. Partial Refund (50%)

4. Partial Refund (Fixed Amount)

Refund Processing

Full Refund

Partial Refund

Best Practices

Related Documentation