View remaining balance for a booking

  • Bookings
  • Payment
  • 1 route
How do I retrieve the payment schedule of one booking?

This scenario explains how to retrieve the payment schedule of an existing booking in order to expose the remaining balance and planned payment milestones for the customer file.

Overview

Use GET/v0/customers/{customer_id}/bookings/{booking_id}/payment_schedules to read the booking payment schedule in customer scope. This is useful to display outstanding amounts and future payment milestones.

Prerequisites

  • customer_id and booking_id must identify an existing booking in customer scope.
  • authorization, accept-language, and x-api-key are required on the documented call.
  • Additional query parameters are not fully visible in the available source material.
1

Retrieve the booking payment schedule

Mandatory

Use GET/v0/customers/{customer_id}/bookings/{booking_id}/payment_schedules to retrieve the future payment deadlines attached to the booking.

Prerequisites

Prepare customer_id, booking_id. Keep x-api-key and, when the route is customer-scoped, a valid bearer token.

Calling CURL

curl -X GET \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: en-US" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  "https://api.clubmed.com/v0/customers/{customer_id}/bookings/{booking_id}/payment_schedules?date_format=ISO"

Example answer

{
  "currency": "EUR",
  "remaining_balance": 1200,
  "schedules": [
    {
      "date": "2026-05-10",
      "amount": 600
    }
  ]
}

info: Use due dates, amounts, and remaining balance markers to present the payment plan still attached to the booking.

Response codes

  • 200 OK: the expected data is returned.
  • 400 Bad Request: the request is invalid or incomplete.
  • 401 Unauthorized: the token is missing or invalid.
  • 403 Forbidden: access is denied in this context.
  • 404 Not Found: the requested resource cannot be found.
GET/v0/customers/{customer_id}/bookings/{booking_id}/payment_schedules
See more