Skip to Content
Prets Developer Portal

Monthly payment preview

POST
/v1/quotes/cost/preview

to try read requests with your account, or paste an API key into the Authorization field. Create an API key in the Partner Portal.

Calculates indicative monthly payments for a quote total without creating a quote or storing anything. Use it to show financing next to a price, for example in your quote editor. Copy is in Dutch by default; send Accept-Language: en for English.

Returns one or more representative examples and a borrowing warning that must be shown with them. Each example is broken down per line when you send lineItems, and links.loanIndicationWidget is included when you call with your organization's API key. Returns 422 when no financing is available for the amount.

Header Parameters

Accept-Language?string

BCP 47 language tag; defaults to nl-NL

Request Body

application/json
  1. body

Indicative financing cost preview

currency*"EUR"

Quote currency (currently EUR only)

Value in"EUR"
totalInclTax*number

Quote total including tax in EUR

Range0 <= value
address?|

Installation address; when omitted, eligibility may be broader where rules allow

lineItems?array<||||||||||||||||||||||||>

Quote line items. When supplied, each representativeExample includes a lineItems[] breakdown pro-rating its monthlyCost across the lines.

Response Body

Representative financing examples for the amount, with the mandatory borrowing warning

application/json
  1. response

Indicative financing cost preview

data*

Indicative financing examples and mandatory warning copy for a quote total.

links?

Present when merchant organization context is available (auth org slug or Prets-Organization).

Authorization

bearerAuth
headerAuthorizationBearer <token>
Example Request
curl -X POST 'https://api.prets.app/v1/quotes/cost/preview' \  -H 'Content-Type: application/json' \  -d '{  "currency": "EUR",  "totalInclTax": 12500}'
Example Response
{  "data": {    "currency": "EUR",    "content": [      {        "type": "text",        "name": "text_warning",        "value": "Caution! Borrowing money costs money"      }    ],    "representativeExamples": [      {        "loanAmount": 12500,        "numInstallments": 120,        "repaymentPeriodUnit": "months",        "monthlyCost": 125,        "totalPayable": 15000,        "nominalAnnualRate": 0.042,        "annualCostRate": 0.045,        "lender": {          "slug": "freo",          "name": "Nationaal Warmtefonds"        },        "content": [          {            "type": "text",            "name": "text_main",            "value": "From €125.00/month"          }        ],        "lineItems": [          {            "externalId": "line-pv-1",            "monthlyCost": 62.5          }        ]      }    ]  },  "links": {    "loanIndicationWidget": {      "png": "https://prets.example.com/widgets/financing-snapshot/png?amount=12500",      "url": "https://prets.example.com/widgets/financing-snapshot?amount=12500"    }  }}