---
uuid: 8b8fddef-b83f-4ea2-aa35-501ca68e4fb7
date_created: 2026-02-26T16:41:34.564Z
date_updated: 2026-04-03T17:04:02.924Z
seo_url: view-remaining-balance-for-a-proposal
category: Payment
tags: 
  - Proposals
  - Payments
routes: 
  - GET /v1/proposals/{proposal_id}/payment_schedule
---

# View remaining balance for a proposal

This scenario explains how to retrieve the payment schedule associated with a proposal in order to expose the remaining balance, installment structure, and payment timeline before booking confirmation or payment collection.

## Flow

false

## Overview

Use `GET /v1/proposals/{proposal_id}/payment_schedule` to read the payment schedule attached to a proposal. This is useful to display the due amounts, payment milestones, or remaining balance in a proposal context.

## Prerequisites

* `proposal_id` must identify an existing proposal.
* `accept-language` and `x-api-key` are required on the documented call.
* Additional query options are not fully visible in the available source material.

## 1 - Retrieve the proposal payment schedule

Use `GET /v1/proposals/{proposal_id}/payment_schedule` to retrieve the expected payment milestones for a proposal before converting it or presenting the remaining balance to the customer.

#### Prerequisites

* Header `x-api-key`
* Path `proposal_id`

#### Calling CURL

```bash
curl -X GET "https://api.clubmed.com/v1/proposals/123456/payment_schedule" \
  -H "x-api-key: <your-api-key>"
```

#### Example answer

```json
{
  "currency": "EUR",
  "commission_included": true,
  "households": [
    {
      "attendees": [
        {
          "id": "A",
          "customer_id": "123456789"
        }
      ],
      "total": 2060,
      "deposit_repayment_schedule": [
        {
          "expected_payment_amount": 1000,
          "deadline": "20100430"
        }
      ]
    }
  ]
}
```

> **info:** Reuse the household totals, deadlines and expected amounts to show the deposit schedule and explain what remains to be paid before confirmation.

***

**Response codes**

* `200`: payment schedule returned successfully.
* `400`: bad request or validation error.
* `403`: forbidden.
* `404`: proposal not found.
* `409`: promotion not applicable for the targeted proposal.

**Related route**: [GET https://api.clubmed.com//v1/proposals/{proposal\_id}/payment\_schedule](https://api.clubmed.com/doc?search=GET%20%2Fv1%2Fproposals%2F%7Bproposal_id%7D%2Fpayment_schedule)