Zum Hauptinhalt springen
Dieser Schnellstart führt dich einmal durch den Ablauf: für eine offene Rechnung einen Zahlungsplan anlegen, ihn abrufen und bei Bedarf verlängern oder kündigen. Alle Beispiele nutzen die Sandbox unter https://preview.coreapi.io. Die vollständigen Parameter und Antwortfelder findest du jeweils auf der verlinkten Referenzseite.
1

Zahlungsplan anlegen

Splitte den offenen Betrag einer finalisierten, unbezahlten Rechnung. Hier gleichmäßig in drei Monatsraten ab dem 5. August.
curl -X POST https://preview.coreapi.io/api/payment-plans \
  -H "Authorization: Bearer api_DEIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "invoiceId": "INVOICE_ID",
    "split": { "count": 3, "interval": "1M", "firstDueAt": "2026-08-05" }
  }'
Alternativ legst du die Raten manuell fest:
curl -X POST https://preview.coreapi.io/api/payment-plans \
  -H "Authorization: Bearer api_DEIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "invoiceId": "INVOICE_ID",
    "installments": [
      { "dueAt": "2026-08-05", "amount": 595 },
      { "dueAt": "2026-09-05", "amount": 595 }
    ]
  }'
Die Antwort enthält den Plan mit "status": "active" und den generierten Raten. Notiere dir die id des Plans.Alle Felder und Antworten: Zahlungsplan anlegen.
2

Plan abrufen

Frage den Plan mit seinen Raten und deren Status jederzeit ab.
curl https://preview.coreapi.io/api/payment-plans/PLAN_ID \
  -H "Authorization: Bearer api_DEIN_TOKEN"
Kennst du nur die Rechnung, nutzt du den rechnungsbezogenen Endpunkt. Er liefert den aktiven Plan, sonst den zuletzt angelegten.
curl https://preview.coreapi.io/api/invoices/INVOICE_ID/payment-plan \
  -H "Authorization: Bearer api_DEIN_TOKEN"
Referenz: Plan abrufen und Plan einer Rechnung abrufen.
3

Auf Ereignisse reagieren

Statt den Plan abzufragen, lässt du dich benachrichtigen. Bei jeder bezahlten Rate feuert payment_plan.rate_paid, beim Abschluss payment_plan.completed, bei einem Planbruch payment_plan.broken. Den Aufbau der Payloads findest du unter Webhooks.
4

Verlängern statt neu anlegen

Braucht der Kunde mehr Zeit oder ist eine Rate ausgefallen, verlängere den Plan. Das ersetzt alle noch nicht bezahlten Raten durch einen neuen Zeitplan. Ein gebrochener Plan kehrt damit nach active zurück.
curl -X POST https://preview.coreapi.io/api/payment-plans/PLAN_ID/extend \
  -H "Authorization: Bearer api_DEIN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "split": { "count": 4, "interval": "1M", "firstDueAt": "2026-10-05" } }'
Referenz: Plan verlängern.
5

Kündigen

Soll der Plan enden, kündige ihn. Der Restbetrag ist danach sofort fällig, das Mahnwesen läuft wieder.
curl -X POST https://preview.coreapi.io/api/payment-plans/PLAN_ID/cancel \
  -H "Authorization: Bearer api_DEIN_TOKEN"
Referenz: Plan kündigen.

​
Nächste Schritte

Kernkonzepte

Plan, Rate, Status, Einzug und die Rundungsregel im Detail.

Webhooks

Die sechs Events im Lebenszyklus eines Plans mit Beispiel-Payloads.