Cancel a booking

Cancel a booking, and optionally mark it as refunded in a single transaction.

  • Only bookings created via API can be cancelled via API
  • You can only cancel future bookings
  • Cancelled bookings will still be visible in some pages in VM
  • Any associated payment records will still be present for cancelled bookings
  • Refunds must be processed externally of ROLLER - Only a record of the refund can be added via API.
šŸ”’

Required scope: Booking_Cancel

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique ID of a booking

Body Params
boolean
required
Defaults to true

Determines if any booking payments are refunded

enum

The method of payment refund (Required when issueRefund is true)

Allowed:
string
length ≤ 32

Optional transaction ID of the refund (Only relevant when issueRefund is true)

string | null

Optional datetime in UTC of the refund transaction (Only relevant when issueRefund is true)

string

Optional comments to add against the refund in booking activity (Only relevant when issueRefund is true)

Responses
200

Success

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json