> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fynn.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Schnellstart

> Von der offenen Rechnung bis zum laufenden Zahlungsplan in wenigen Aufrufen.

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.

<Steps>
  <Step title="Zahlungsplan anlegen">
    Splitte den offenen Betrag einer finalisierten, unbezahlten Rechnung. Hier gleichmäßig in drei Monatsraten ab dem 5. August.

    ```bash theme={null}
    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:

    ```bash theme={null}
    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](/v2-payment-plans-api/payment-plans/create-payment-plan).
  </Step>

  <Step title="Plan abrufen">
    Frage den Plan mit seinen Raten und deren Status jederzeit ab.

    ```bash theme={null}
    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.

    ```bash theme={null}
    curl https://preview.coreapi.io/api/invoices/INVOICE_ID/payment-plan \
      -H "Authorization: Bearer api_DEIN_TOKEN"
    ```

    Referenz: [Plan abrufen](/v2-payment-plans-api/payment-plans/get-payment-plan) und [Plan einer Rechnung abrufen](/v2-payment-plans-api/payment-plans/get-invoice-payment-plan).
  </Step>

  <Step title="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](/v2-payment-plans-api/webhooks).
  </Step>

  <Step title="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.

    ```bash theme={null}
    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](/v2-payment-plans-api/payment-plans/extend-payment-plan).
  </Step>

  <Step title="Kündigen">
    Soll der Plan enden, kündige ihn. Der Restbetrag ist danach sofort fällig, das Mahnwesen läuft wieder.

    ```bash theme={null}
    curl -X POST https://preview.coreapi.io/api/payment-plans/PLAN_ID/cancel \
      -H "Authorization: Bearer api_DEIN_TOKEN"
    ```

    Referenz: [Plan kündigen](/v2-payment-plans-api/payment-plans/cancel-payment-plan).
  </Step>
</Steps>

## Nächste Schritte

<CardGroup cols={2}>
  <Card title="Kernkonzepte" icon="book" href="/v2-payment-plans-api/concepts">
    Plan, Rate, Status, Einzug und die Rundungsregel im Detail.
  </Card>

  <Card title="Webhooks" icon="bell" href="/v2-payment-plans-api/webhooks">
    Die sechs Events im Lebenszyklus eines Plans mit Beispiel-Payloads.
  </Card>
</CardGroup>