Get payment schedule

POSThttps://api.dcdial.com/api/type=get_schedules

Read onlyToken

Returns every scheduled payment of a payment agreement or recurring plan, with dates, amounts, the balance after each payment and its status.

Parameters

Send as application/x-www-form-urlencoded.

typestringrequired
Selects the operation. Always get_schedules for this endpoint.
tokenstringrequired
Your API token from Log in. See Authentication.
schedule_idintegerrequired
ID of the recurring plan, or of the agreement when plan=Y.
Example 77120
planstringoptional
Y when schedule_id is a payment agreement ID (from Create payment agreement).
One ofY
user_timezonestringoptional
Time zone to show dates in, for example America/New_York.
Example America/New_York

Notes

This endpoint returns its data without the response wrapper.

curl https://api.dcdial.com/api/ \
  -d type=get_schedules \
  -d token="$DCDIAL_TOKEN" \
  -d schedule_id=77120

<?php
$ch = curl_init('https://api.dcdial.com/api/');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POSTFIELDS => http_build_query([
        'type' => 'get_schedules',
        'token' => getenv('DCDIAL_TOKEN'),
        'schedule_id' => 77120,
    ]),
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);

if (($result['response']['success'] ?? 0) != 1) {
    throw new RuntimeException($result['response']['error'] ?? 'Request failed');
}

const res = await fetch('https://api.dcdial.com/api/', {
  method: 'POST',
  body: new URLSearchParams({
    type: "get_schedules",
    token: process.env.DCDIAL_TOKEN,
    schedule_id: "77120",
  }),
});
const { response } = await res.json();
if (response.success != 1) throw new Error(response.error);

import os
import requests

r = requests.post(
    "https://api.dcdial.com/api/",
    data={
        "type": "get_schedules",
        "token": os.environ["DCDIAL_TOKEN"],
        "schedule_id": 77120,
    },
    timeout=30,
)
response = r.json()["response"]
if str(response.get("success")) != "1":
    raise RuntimeError(response.get("error"))

{
  "customer_information": "Jane Doe - ACC-10045",
  "schedule": [
    {
      "schedule_date": "2026-11-01",
      "payment_amount": "150.00",
      "remaining_balance": "750.00",
      "Status": "Completed"
    },
    {
      "schedule_date": "2026-12-01",
      "payment_amount": "150.00",
      "remaining_balance": "600.00",
      "Status": "Scheduled"
    }
  ]
}

Try it