Skip to content
campaiDeveloper
campai.com

Booking ยท Events

GET/{organizationId}/{mandateId}/booking/events/{eventId}/cancellation-refundReads only

Preview cancellation refund

Previews the refund for cancelling one date of an event. Supply organizationId, nullable mandateId, eventId, and a fullRefund boolean. The response gives the total and monetary refund, paid booking count, whether it includes a whole-course share, and whether refund policies reduce it. Nothing is changed.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Who may call it

  • Callers must have access to the organization.
  • Callers need the mandate.read permission.
  • Callers need the event.edit permission.

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • eventIdidrequired

Query parameters

  • fullRefundbooleanrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/booking/events/YOUR_EVENT_ID/cancellation-refund' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • totalPriceRefundnumber
  • monetaryPriceRefundnumber
  • paidBookingCountnumber
  • hasCourseShareboolean
  • isReducedByRefundPoliciesboolean
Response200
{
  "totalPriceRefund": 1,
  "monetaryPriceRefund": 1,
  "paidBookingCount": 1,
  "hasCourseShare": true,
  "isReducedByRefundPolicies": true
}

Errors

Other errors

StatusErrorWhen
404The given event was not foundIf the event is not found, the endpoint returns HTTP 404 with key booking.event.eventNotFound.

Errors nearly every request can meet are listed under Errors.