Retrieving payment schedule associated with a proposal

  • Payment
  • 1 route
How can I view upcoming payments?

This scenario explains how to receive the payment schedule associated with a proposal before it is validated as a booking.

Overview

Use this scenario to retrieve the payment schedule associated with a proposal before it is turned into a booking. The response lets you display due dates, expected amounts, and the remaining balance.

Prerequisites

  • Have a valid proposal_id.
  • Send x-api-key and, when the journey requires it, accept-language.
1

Retrieve the payment schedule associated with a proposal

Mandatory

This route returns the proposal payment schedule, including the total amount and the next repayment milestones.

Prerequisites

Use the proposal identifier. The response depends on the commercial conditions that are still valid on the proposal.

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: This response is useful to display a payment schedule on screen or to prepare a repayment summary before checkout.

Response codes

  • 200 OK: the payment schedule is returned.
  • 400 Bad Request: invalid parameters.
  • 403 Forbidden: access denied.
  • 404 Not Found: proposal not found.
  • 409 Conflict: the promotion or proposal is no longer applicable.
GET/v1/proposals/{proposal_id}/payment_schedule
See more