Récupération de l'échéancier de paiement associé à une proposition

  • Paiement
  • 1 route
Comment je peux afficher les paiements à venir ?

Ce scénario explique comment recevoir le calendrier de paiement associé à une proposition avant sa validation en tant que réservation.

Vue d'ensemble

Utilisez ce scénario pour récupérer l'échéancier de paiement associé à une proposition avant sa transformation en réservation. La réponse permet d'afficher les échéances, les montants attendus et le reste à payer.

Prérequis

  • Disposer d'un proposal_id valide.
  • Fournir x-api-key et, si le parcours le demande, accept-language.
1

Récupérer l’échéancier de paiement de la proposition

Obligatoire

Cette route retourne l'échéancier de paiement de la proposition, avec le total et les prochaines échéances.

Prérequis

Munissez-vous de l'identifiant de proposition. La réponse dépend des conditions commerciales encore valides sur cette proposition.

Calling CURL

curl -X GET \
  -H "x-api-key: $API_KEY" \
  "https://api.clubmed.com/v1/proposals/{proposal_id}/payment_schedule"

Example answer

{
  "currency": "EUR",
  "commission_included": true,
  "households": [
    {
      "id": "household-1",
      "amount": {
        "amount": 1200,
        "currency": "EUR"
      }
    }
  ],
  "total": {
    "amount": 3200,
    "currency": "EUR"
  },
  "deposit_repayment_schedule": [
    {
      "date": "2026-05-10",
      "amount": {
        "amount": 800,
        "currency": "EUR"
      }
    }
  ]
}

info: Cette réponse est utile pour afficher un échéancier à l'écran ou préparer un récapitulatif avant encaissement.

Codes de réponse

  • 200 OK : l'échéancier est renvoyé.
  • 400 Bad Request : paramètres invalides.
  • 403 Forbidden : accès refusé.
  • 404 Not Found : proposition introuvable.
  • 409 Conflict : la promotion ou la proposition n'est plus applicable.
GET/v1/proposals/{proposal_id}/payment_schedule
Voir plus