Livedocs/api-reference/order-preview
Order Preview
Check whether the selected company/document combination is orderable.
Order Preview
Preview is flexible enough for UX exploration but returns ordering_eligible=false when verified company context is missing.
POST
/api/v1/documents/orders/preview/Preview order eligibility before creating a paid document order.
Status
Live
Auth
Session gated
Credit cost
0
Request
Preview may accept missing company_profile_id, but then returns ordering_eligible=false.
Request body
{
"company_profile_id": "9f2...",
"document_type": "AD",
"plan_id": "pay-per-doc"
}Response
Returns eligibility, product information, and the reason a result can or cannot proceed.
Response body
{
"ordering_eligible": true,
"company_profile_id": "9f2...",
"document_type": "AD",
"estimated_total": "19.00",
"currency": "EUR"
}Ordering eligibility
- Preview can be non-orderable; Create Order is stricter.
- Use preview to explain blockers before the user reaches payment.
Code examples
cURL
curl -X POST https://openregis.com/api/v1/documents/orders/preview/ \
-H "Content-Type: application/json" \
-d '{"company_profile_id":"9f2...","document_type":"AD","plan_id":"pay-per-doc"}'Errors
| Code | Meaning | Client action |
|---|---|---|
| validation_error | The preview payload is malformed. | Correct the request before creating an order. |