Schemas

External order id in the Vignette ID system.

Order id in the Partner system (sent on creation).

Partner order id as stored on the Vignette ID side.

Order status. One of CREATED, COMPLETED, FAILED, REFUNDED, CANCELED.

Order amount in major units of currency.

Provider that processed the payment. null until the order is paid.

Timestamp when the order was cancelled via Cancel External Order. null for orders that were never cancelled.

URL to show to the customer to complete the payment.

Payment attempts recorded for this order.

Total number of orders matching the filter.

Error can be null, a simple string code, or an object with details.

Error can be null, a simple string code, or an object with details.

Vehicle type of the order, e.g. car, van, moto.

Whether the order can be modified right now, and until when. Present only on orders bought with Flexible Service; on non-Flex orders reason_code is no_flex.

A refund tier. The full_refund and partial_refund tiers are mutually exclusive — at most one is eligible at a time; if neither, there is no refund. A pending tier still reports its terms (amount_eur, available_at) so you can show "€X now, or €Y after ".

A refund tier. The full_refund and partial_refund tiers are mutually exclusive — at most one is eligible at a time; if neither, there is no refund. A pending tier still reports its terms (amount_eur, available_at) so you can show "€X now, or €Y after ".

Flexible Service configuration recorded on the order. Present only when the order was bought with Flex.

Error can be null, a simple string code, or an object with details.

Error can be null, a simple string code, or an object with details.

Error can be null, a simple string code, or an object with details.

Can the order be modified right now?

Unix seconds when the action becomes possible. null means either available now or never — read eligible to tell which.

Unix seconds of the last instant the action is possible. null when there is no window. Trust this over your own clock arithmetic — it is the authoritative value.

The governing rule, always populated whether eligible or not. E.g. default_flex_window, expanded_flex_window, window_passed, no_flex, already_modified.

Can this refund tier be taken right now?

Unix seconds when this tier opens. null means available now or never — read eligible to tell which.

Unix seconds of the last instant this tier is available. null when there is no window.

Exact amount that will be credited, in EUR. Render it; never recompute it. null when not applicable.

Display-only tier label, e.g. 100 or 50. Do not multiply anything by it — use amount_eur. null when not applicable.

The governing rule, always populated. E.g. more_than_6h_before_start, within_6h_of_start, within_1h_of_purchase, full_refund_applies, window_passed, no_flex, already_refunded.

Flex plan on the order.

Flex fee actually charged for this order, in EUR.

List price of the Flex plan before any discount, in EUR.

true when the partner absorbed the Flex fee instead of charging the customer.

Email of an existing vignette.id user who will receive the order.

The account is not created automatically - validate the recipient first via GET /public/users/exists.