curl https://api.khaime.com/api/v1/products/3046/installment-quote \
-H "X-API-Key: pk_sandbox_your_key"
Installments
Installment Quote
Preview a product’s installment schedule.
GET
/
products
/
{product_id}
/
installment-quote
curl https://api.khaime.com/api/v1/products/3046/installment-quote \
-H "X-API-Key: pk_sandbox_your_key"
Installment Quote
Intro
Returns the amount of each installment for a product sold in installments, and when each would fall due if the plan started today. Use it to show the schedule before checkout.Context
The schedule comes from the product’sinstallment_plan template (see Installments). Amounts are computed the same way checkout computes them — whole minor units that add up exactly to the price — so what you show is what the customer is charged.
Hows
GET /products/{product_id}/installment-quote
Path parameters
| Parameter | Type | Description |
|---|---|---|
product_id | integer | A product of your business (or an active sub-merchant’s) in your key’s environment. |
Response
{
"status": true,
"message": "Installment quote",
"data": {
"product_id": 3046,
"currency": "usd",
"total_amount": 10000,
"installments": [
{ "position": 1, "label": "Deposit", "amount": 4000, "due_date": "2026-09-28T10:00:00.000Z" },
{ "position": 2, "label": "Second payment", "amount": 3000, "due_date": "2026-10-28T10:00:00.000Z" },
{ "position": 3, "label": "Final payment", "amount": 3000, "due_date": "2026-11-28T10:00:00.000Z" }
]
}
}
Errors
| Status | error_code | Cause |
|---|---|---|
| 400 | INSTALLMENT_NOT_ALLOWED | The product isn’t sold in installments, or its template is invalid |
| 404 | PRODUCT_NOT_FOUND | Not your product, or not in your key’s environment |
| 422 | VALIDATION_FAILED | product_id isn’t a positive integer |
curl https://api.khaime.com/api/v1/products/3046/installment-quote \
-H "X-API-Key: pk_sandbox_your_key"
Whys
The quote is priced at the product’s catalogue price in its own currency. Checkout applies currency conversion and discounts to the total and then splits it with the same rules, so the parts keep their proportions.Why nots
- Due dates here assume the plan starts today; a real plan’s dates run from the day its first installment is paid.
- The quote doesn’t include fees or currency conversion; use the checkout response for the exact amount charged now.
