Get the payment plan of an invoice

Return the payment plan attached to an invoice. If an active plan exists it is returned, otherwise the most recent plan of any status. Responds with 404 if the invoice never had a plan.

GET /api/invoices/{id}/payment-plan

Get the payment plan of an invoice

cURL

curl --request GET \
  --url https://coreapi.io/api/invoices/{id}/payment-plan \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://coreapi.io/api/invoices/{id}/payment-plan"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://coreapi.io/api/invoices/{id}/payment-plan', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://coreapi.io/api/invoices/{id}/payment-plan",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

200

{
  "id": "10000000-0000-0000-00e0-000000000001",
  "invoiceId": "10000000-0000-0000-0003-000000000001",
  "totalAmount": 1190,
  "currencyCode": "EUR",
  "paymentMethodId": "10000000-0000-0000-004f-000000000001",
  "createdAt": "2026-07-05T16:20:00+00:00",
  "completedAt": null,
  "brokenAt": null,
  "canceledAt": null,
  "brokenReason": null,
  "installments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "position": 1,
      "dueAt": "2026-08-05",
      "amount": 595,
      "paidAt": null
    }
  ]
}

{
  "status": 422,
  "type": "PAYMENT_PLAN__SUM_MISMATCH",
  "title": "An error occurred",
  "detail": "The installments must sum to the open amount of the invoice."
}

{
  "status": 422,
  "type": "PAYMENT_PLAN__SUM_MISMATCH",
  "title": "An error occurred",
  "detail": "The installments must sum to the open amount of the invoice."
}

{
  "status": 422,
  "type": "PAYMENT_PLAN__SUM_MISMATCH",
  "title": "An error occurred",
  "detail": "The installments must sum to the open amount of the invoice."
}

Autorisierungen

Authorization · string · header · erforderlich

Organisation API token. Send it as Authorization: Bearer api_... The token is scoped to a single Organisation. Reading a plan needs the invoice read permission, creating, canceling and extending need the invoice write permission.

Pfadparameter

id · string<uuid> · erforderlich

The invoice UUID.

Beispiel:

"10000000-0000-0000-0003-000000000001"

Antwort

200

application/json

The payment plan of the invoice.

id · string<uuid> · erforderlich

Beispiel:

"10000000-0000-0000-00e0-000000000001"

invoiceId · string<uuid> · erforderlich

Beispiel:

"10000000-0000-0000-0003-000000000001"

status · enum<string> · erforderlich

Lifecycle status of a payment plan.

Verfügbare Optionen: active, completed, broken, canceled

totalAmount · integer · erforderlich

Sum of all installments in cents. Equals the open amount at creation.

Beispiel:

1190

currencyCode · string · erforderlich

Beispiel:

"EUR"

paymentMethodId · string<uuid> | null · erforderlich

Beispiel:

"10000000-0000-0000-004f-000000000001"

createdAt · string<date-time> · erforderlich

Beispiel:

"2026-07-05T16:20:00+00:00"

completedAt · string<date-time> | null · erforderlich

Timestamp the plan completed (all installments paid), or null.

Beispiel:

null

brokenAt · string<date-time> | null · erforderlich

Timestamp the plan broke, or null.

Beispiel:

null

canceledAt · string<date-time> | null · erforderlich

Timestamp the plan was canceled, or null.

Beispiel:

null

brokenReason · string | null · erforderlich

Reason the plan broke, or null while active.

Beispiel:

null

installments · object[] · erforderlich

Show child attributes