Consulter le solde restant d’un booking

  • Bookings
  • Paiement
  • 1 route
Comment récupérer l'échéancier de paiement d'un dossier ?

Ce scénario explique comment récupérer l'échéancier de paiement d'un booking existant afin d'exposer le solde restant et les jalons de paiement prévus pour le dossier client.

Vue d'ensemble

Utilisez GET/v0/customers/{customer_id}/bookings/{booking_id}/payment_schedules pour lire l'échéancier de paiement du booking dans le scope client. Cela permet d'afficher les montants restant dus et les prochaines échéances.

Prérequis

  • customer_id et booking_id doivent identifier un booking existant dans le scope client.
  • authorization, accept-language et x-api-key sont requis sur l'appel documenté.
  • Les paramètres de requête complémentaires ne sont pas entièrement visibles dans la matière source disponible.
1

Récupérer l’échéancier de paiement du booking

Obligatoire

Utilisez GET/v0/customers/{customer_id}/bookings/{booking_id}/payment_schedules pour récupérer les échéances de paiement futures rattachées au booking.

Prérequis

Préparez customer_id, booking_id. Conservez x-api-key et, si la route est customer-scoped, un bearer token valide.

Calling CURL

curl -X GET \
  -H "x-api-key: YOUR_API_KEY" \
  -H "accept-language: fr-FR" \
  -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: Exploitez les dates d'échéance, les montants et les repères de solde restant pour afficher le plan de paiement du dossier.

Codes de réponse

  • 200 OK : les données attendues sont renvoyées.
  • 400 Bad Request : la requête est invalide ou incomplète.
  • 401 Unauthorized : le token est manquant ou invalide.
  • 403 Forbidden : l'accès est refusé dans ce contexte.
  • 404 Not Found : la ressource demandée est introuvable.
GET/v0/customers/{customer_id}/bookings/{booking_id}/payment_schedules
Voir plus