Skip to main content
POST
/
v1
/
members
/
{memberId}
/
bookings
/
{bookingId}
/
cancel
Cancel booking
curl --request POST \
  --url https://api.halth.com/v1/members/{memberId}/bookings/{bookingId}/cancel
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "serviceDate": "2023-11-07T05:31:56Z",
  "paid": true,
  "organisation": {
    "id": "<string>",
    "name": "<string>",
    "brandImageUrl": "<string>"
  },
  "location": {
    "id": "<string>",
    "address": {}
  },
  "provider": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "profileImageUrl": "<string>"
  },
  "appointmentType": {
    "id": "<string>",
    "name": "<string>",
    "durationMinutes": 123
  },
  "servicePrice": 123,
  "cancellationPolicy": {
    "enabled": true,
    "rules": {
      "clientCancel": {
        "enabled": true,
        "reason": "booking_paid"
      },
      "clientReschedule": {
        "enabled": true,
        "reason": "booking_paid"
      }
    },
    "fee": {
      "amount": 123,
      "freeCancellationHours": 123,
      "latestNoFeeAt": "2023-11-07T05:31:56Z",
      "billable": true,
      "percent": 123
    }
  }
}

Path Parameters

memberId
string
required
bookingId
string
required

Response

200 - application/json
id
string
required
createdAt
string<date-time>
required
status
string
required
serviceDate
string<date-time>
required
paid
boolean
required
organisation
object
required
location
object
required
provider
object
required
appointmentType
object
required
servicePrice
number
cancellationPolicy
object