⌘K

Error codes

The complete code registry the contract publishes. Each row shows the statuses and retry behaviour the contract's own examples demonstrate.

Code	HTTP	Retryable	Declared on
VALIDATION	400 · 405 · 413 · 414 · 415	not retryable	159 endpoints
UNKNOWN_DOMAIN	400	not retryable	86 endpoints
UNAUTHENTICATED	401	not retryable	143 endpoints
PERMISSION_DENIED	403 · 423	not retryable	130 endpoints
TAB_DISABLED	403	not retryable	75 endpoints
OUT_OF_SCOPE	403	not retryable	75 endpoints
TENANT_MISMATCH	403	not retryable	75 endpoints
TENANT_SUSPENDED	403	not retryable	21 endpoints
NOT_FOUND	404	not retryable	80 endpoints
CONFLICT	409	depends on the case	53 endpoints
OFFER_EXPIRED	409	not retryable	15 endpoints
QUOTE_EXPIRED	409	not retryable	5 endpoints
HOLD_EXPIRED	409	not retryable	12 endpoints
PRICE_CHANGED	409	not retryable	5 endpoints
PENALTY_CHANGED	409	not retryable	2 endpoints
IDEMPOTENCY_CONFLICT	409	not retryable	47 endpoints
IDEMPOTENCY_IN_PROGRESS	409	retryable	29 endpoints
DUPLICATE_ORDER	409	not retryable	1 endpoint
TRAVELER_MISMATCH	422	not retryable	3 endpoints
SOLD_OUT	422	not retryable	7 endpoints
PAYMENT_FAILED	402	not retryable	4 endpoints
SEARCH_WARMING	429	retryable	1 endpoint
RATE_LIMITED	429	retryable	82 endpoints
UPSTREAM_UNAVAILABLE	502	retryable	44 endpoints
PROVIDER_DOWN	503	retryable	27 endpoints
AMBIGUOUS_RESULT			Not an error body
NOT_IMPLEMENTED	501	not retryable	68 endpoints
INTERNAL	500	depends on the case	161 endpoints

The error body

Every non-2xx response has exactly this shape.

codestringRequired
The complete, closed list of error codes; a finer cause rides in details.reason, never as a new code.Show more
The complete, closed list of error codes; a finer cause rides in details.reason, never as a new code. Two codes are delivered as 2xx answers rather than error bodies: AMBIGUOUS_RESULT is the 202 OrderResponse (the booking's outcome is not yet known; read the order), and SEARCH_WARMING is primarily the 202 SearchResponse (keep polling), with a 429 form only on legacy flight searches. TENANT_SUSPENDED (403, not retryable) refuses a suspended tenant's new business and new credentials. A supplier charge that differs from the price you consented to is a 409 CONFLICT with details.reason SUPPLIER_PRICE_MISMATCH on the order write (details carry consentedPrice, supplierPrice and repriceRequired), and later the order.supplier_price_mismatch event. six agent identity refusals ride as details.reason under stable codes; this enum does not grow. 401 UNAUTHENTICATED details.reason AGENT_SIGNATURE_INVALID (nextAction reauth; details.signatureReason BAD_SIGNATURE, STALE, FUTURE, MISSING_COMPONENT or DIGEST_MISMATCH) is a Web Bot Auth signature that is present and wrong; a request with no signature is never refused for it. 401 UNAUTHENTICATED AGENT_VERSION_REVOKED (stop; AGENT_SUSPENDED for a suspended agent) is a covered Agent-Version header that names a REVOKED version. 403 PERMISSION_DENIED AGENT_TIER_INSUFFICIENT (verify_agent) is a tool class the agent's tier ceiling does not allow: details carry tier, requiredTier, toolClass and operationId, and the ceiling only ever narrows an unverified caller, it never widens a scope. 409 CONFLICT HANDLE_TAKEN and 422 VALIDATION HANDLE_RESERVED (both stop) refuse a handle at registration. 409 CONFLICT DOMAIN_NOT_VERIFIED (verify_agent) is a domain proof that does not hold yet (details.txtName, details.expected).
- VALIDATION
- UNKNOWN_DOMAIN
- UNAUTHENTICATED
- PERMISSION_DENIED
- TAB_DISABLED
- OUT_OF_SCOPE
- TENANT_MISMATCH
- TENANT_SUSPENDED
- NOT_FOUND
- CONFLICT
- OFFER_EXPIRED
- QUOTE_EXPIRED
- HOLD_EXPIRED
- PRICE_CHANGED
- PENALTY_CHANGED
- IDEMPOTENCY_CONFLICT
- IDEMPOTENCY_IN_PROGRESS
- DUPLICATE_ORDER
- TRAVELER_MISMATCH
- SOLD_OUT
- PAYMENT_FAILED
- SEARCH_WARMING
- RATE_LIMITED
- UPSTREAM_UNAVAILABLE
- +4
messagestringRequired
traceIdstringRequired
The support handle: the 32-hex W3C trace id.Show more
The support handle: the 32-hex W3C trace id. When the request carried a valid `traceparent` the platform continues that trace and this is its trace id; otherwise a new trace starts. `X-Correlation-Id` is your own handle, echoed on the response; it never replaces traceId. Quote traceId to support.
retryablebooleanRequired
nextActionstringOptional
An x-extensible-enum plus the complete_step: pattern; a client that does not know a value falls back to code and retryable.Show more
An x-extensible-enum plus the complete_step: pattern; a client that does not know a value falls back to code and retryable. Never free text from a supplier. REST and MCP (the isError result) carry the identical body.
docsstring · uriOptional
the public page that explains this error and what to do, under the developer portal's errors reference, https://apiq.example/developers/errors#<anchor>.Show more
the public page that explains this error and what to do, under the developer portal's errors reference, https://apiq.example/developers/errors#<anchor>. The anchor is the kebab-case details.reason where the body carries one (SCOPE_WIDENING is #scope-widening), else the kebab-case code (#rate-limited).
detailsobjectOptional
Code-specific payload, and open by design: every code carries what it needs, so a client reads the keys it knows about and ignores the rest.Show more
Code-specific payload, and open by design: every code carries what it needs, so a client reads the keys it knows about and ignores the rest. The keys declared below are the ones a client needs to handle the booking lifecycle (the accepted domains of UNKNOWN_DOMAIN, the old and new price of PRICE_CHANGED, the existing orderRef of DUPLICATE_ORDER, retryAfterMs); everything else is code-specific. `snapshotPenalty` / `supplierPenalty` — PENALTY_CHANGED with reason CONTRADICTS_BOOKED_TERMS: what the cancellation terms the order was booked on charge now, and what the supplier quoted, both in the order's currency at its booked FX snapshot (fxApplied / fxSnapshotId when converted), beside `orderRef` and `at` (the instant the terms were read at). Raised on cancel-quote and cancel before any consent is read or anything is committed; no consent overrides it. `state` / `attempted` / `links` — CONFLICT on cancel-quote or cancel of an order that is over: the order's current state, the verb refused (cancel-quote | cancel), and the routes the order still offers (self, documents, events — no servicing verb), beside `orderRef`. Nothing was sent to the supplier and nothing was written. `accepted` — UNKNOWN_DOMAIN's accepted domain list. `orderRef` — DUPLICATE_ORDER's existing order, the backstop for a client that re-books while an order is PENDING_RECONCILIATION. `retryAfterMs` — SEARCH_WARMING and the retryable codes; on a 429 it mirrors the Retry-After header. `reason` — a machine-readable sub-reason where one code covers several causes, left undeclared as a key because its values are code-specific: on an identity-route 429 RATE_LIMITED it is CLIENT_RATE_LIMITED | SUBJECT_RATE_LIMITED, beside `action` (signup | signup-verify | login | password-forgot | password-reset | invite-accept | oauth-token | oauth-token-failure | oauth-token-issued); on a 409 CONFLICT from DELETE /v1/keys/{keyPrefix} it may be KEY_CHANGED_CONCURRENTLY; on a 403 TENANT_SUSPENDED it is TENANT_SUSPENDED, beside `verb` (the refused verb) where a verb was refused; on a key-mint 403 PERMISSION_DENIED it may be TENANT_NOT_LIVE, and on the production deployment so may a verb or payments route's 403 PERMISSION_DENIED, beside `verb` or `route`. Also PERMISSION_DENIED OWNER_OR_ADMIN_ONLY (key pause and resume); CONFLICT KEY_NOT_ACTIVE, KEY_NOT_PAUSED, ROTATION_TOO_EARLY (beside `expiresAt`) and DEVICE_SIGNUP_DECIDED; VALIDATION EMAIL_MISMATCH and CODE_INVALID (device sign-up approval); NOT_IMPLEMENTED DEVICE_SIGNUP_UNAVAILABLE, AGENT_KEYS_UNAVAILABLE and ONBOARD_UNAVAILABLE; and on an identity-route 429 the `action` values signup-device, signup-device-lookup and signup-device-approve. adds sub-reasons, never codes: VALIDATION FREE_MAIL_DOMAIN and DOMAIN_NOT_COMPANY (the work e-mail); NOT_FOUND REGISTRATION_NOT_FOUND and NOT_IMPLEMENTED REGISTER_UNAVAILABLE (the registration look-up by number); CONFLICT COUNTRY_NOT_LIVE (beside `country`, the tenant's ISO 3166-1 alpha-2 country), PREREQUISITES_OPEN (beside `open`, the open step keys), WORK_EMAIL_REQUIRED and ALREADY_LIVE (POST /v1/activation:go-live); the existing FLOW_NOT_CAPPED, REGISTRATION_LOCKED, GSTIN_NOT_ACTIVE, GSTIN_ALREADY_CLAIMED, STEP_UP_FAILED, STEP_UP_LOCKED and SUBJECT_RATE_LIMITED (`action` work-email-code-send) on the new routes. round 3 adds sub-reasons, never codes: CONFLICT SIGNATORY_NOT_MATCHED, VERIFICATION_IN_REVIEW and VERIFICATION_REJECTED (PUT /v1/activation/business-people), with the existing REGISTRATION_NOT_CONFIRMED and ALREADY_VERIFIED there and NOT_IMPLEMENTED KYB_UNAVAILABLE (beside `country`); VALIDATION VPA_INVALID (POST /v1/payments/methods, the UPI provider refused the VPA). A business that is not verified yet keeps CONFLICT PREREQUISITES_OPEN on POST /v1/activation:go-live. go-live review adds sub-reasons, never codes: CONFLICT GO_LIVE_IN_REVIEW (POST /v1/activation:go-live while a go-live review is open) and VALIDATION PRODUCT_NOT_AVAILABLE (beside `field` products; a requested product is not in the tenant's sandbox capabilities); on POST /ops/v1/approvals/{id}:approve of a GO_LIVE_REVIEW, CONFLICT GO_LIVE_TEST_CALLS_MISSING (beside `missingTestCalls`) and CONFLICT PREREQUISITES_OPEN (beside `open`). On the money and quote verbs `reason` also carries the as-built sub-reason: QUOTE_EXPIRED NO_SELL_PRICE_STAMP / SELL_PRICE_STAMP_MISMATCH, SOLD_OUT OFFER_UNSELLABLE, INTERNAL FX_SNAPSHOT_UNAVAILABLE, CONFLICT PENDING_RECONCILIATION, PERMISSION_DENIED APPROVAL_*; on the cancel verbs PENALTY_CHANGED CONTRADICTS_BOOKED_TERMS and INTERNAL FX_SNAPSHOT_UNAVAILABLE. An open string: clients branch on code first and read reason when they know it. `pricesWithheld` — PRICE_CHANGED with every amount removed because not all of them could be stated as sell prices; previousPrice / price are then absent and a reprice shows the new price. `repriceRequired` — a fresh reprice is required. `field` — the request member a refusal is about (VALIDATION, and CONFLICT on the order payment check, where it is message.intent.payment.paymentRef). `detail` — a second-level qualifier under `reason` where one reason covers several cases: AMOUNT | CURRENCY under AMOUNT_MISMATCH, and the payment intent's state under WRONG_STATE.
27 child attributes
- reasonstringOptional
- fieldstringOptional
- detailstringOptional
- pricesWithheldbooleanOptional
- repriceRequiredbooleanOptional
- previousPriceMoneyOptional
  Integer minor units + ISO-4217, never floats (platform law)
  5 child attributes
  - amountintegerRequired
    Minor units
  - currencystringRequired
    ISO-4217
  - fxAppliedbooleanOptional
    True when the amount was converted from the supplier's currency.
  - fxSnapshotIdstringOptional
    The exchange-rate snapshot the amount was converted with, fixed when the price was quoted.
  - breakdownarray of PriceBreakdownLineOptional
    Sell-side component lines summing to amount; the platform may send it empty.Show more
    Sell-side component lines summing to amount; the platform may send it empty. One line shape everywhere — the same PriceBreakdownLine the rule simulation answers. Never carries a supplier net.
    13 child attributes
    typestringRequired
    The kind of line, for example BASE, TAX, FEE or DISCOUNT.
    amountintegerRequired
    Minor units
    feeTypestringOptional
    For FEE lines produced by a FEE_LINE rule — the tenant's fee label
    labelstringOptional
    Display label in the request locale
    taxComponentstringOptional
    For GST / TAX lines — CGST | SGST | IGST | UTGST | CESS | VAT | SALES_TAX | OCCUPANCY_TAX; open string
    taxCodeTaxCodeOptional
    The statutory classification of a taxed line (SAC/HSN in India, VAT codes elsewhere)
    rateBasisPointsintegerOptional
    The tax or fee rate in basis points when the line is rate-based (1800 = 18%)
    collectedBystringOptional
    PLATFORM | SUPPLIER | PROPERTY — who takes the money; a non-PLATFORM line outside Offer.price is a pay-at-property disclosure
    payableAtstringOptional
    BOOKING | PROPERTY | DESK | AFTER_SERVICE
    includedbooleanOptional
    True when the line is inside the enclosing amount (default); false for a disclosed line outside it
    quantityintegerOptional
    How many units the line covers, when more than one.
    unitAmountintegerOptional
    Minor units per unit when quantity is given
    currencystringOptional
    ISO-4217 code of this line's amount and unitAmount.Show more
    ISO-4217 code of this line's amount and unitAmount. Set ONLY on a disclosed line (included false) that is NOT in the enclosing price's currency, for example a resort fee payable at the property in its local currency. Absent means the enclosing price's currency, as before; a line inside the total never carries it.
- priceMoneyOptional
  Integer minor units + ISO-4217, never floats (platform law)
  5 child attributes
  - amountintegerRequired
    Minor units
  - currencystringRequired
    ISO-4217
  - fxAppliedbooleanOptional
    True when the amount was converted from the supplier's currency.
  - fxSnapshotIdstringOptional
    The exchange-rate snapshot the amount was converted with, fixed when the price was quoted.
  - breakdownarray of PriceBreakdownLineOptional
    Sell-side component lines summing to amount; the platform may send it empty.Show more
    Sell-side component lines summing to amount; the platform may send it empty. One line shape everywhere — the same PriceBreakdownLine the rule simulation answers. Never carries a supplier net.
    13 child attributes
    typestringRequired
    The kind of line, for example BASE, TAX, FEE or DISCOUNT.
    amountintegerRequired
    Minor units
    feeTypestringOptional
    For FEE lines produced by a FEE_LINE rule — the tenant's fee label
    labelstringOptional
    Display label in the request locale
    taxComponentstringOptional
    For GST / TAX lines — CGST | SGST | IGST | UTGST | CESS | VAT | SALES_TAX | OCCUPANCY_TAX; open string
    taxCodeTaxCodeOptional
    The statutory classification of a taxed line (SAC/HSN in India, VAT codes elsewhere)
    rateBasisPointsintegerOptional
    The tax or fee rate in basis points when the line is rate-based (1800 = 18%)
    collectedBystringOptional
    PLATFORM | SUPPLIER | PROPERTY — who takes the money; a non-PLATFORM line outside Offer.price is a pay-at-property disclosure
    payableAtstringOptional
    BOOKING | PROPERTY | DESK | AFTER_SERVICE
    includedbooleanOptional
    True when the line is inside the enclosing amount (default); false for a disclosed line outside it
    quantityintegerOptional
    How many units the line covers, when more than one.
    unitAmountintegerOptional
    Minor units per unit when quantity is given
    currencystringOptional
    ISO-4217 code of this line's amount and unitAmount.Show more
    ISO-4217 code of this line's amount and unitAmount. Set ONLY on a disclosed line (included false) that is NOT in the enclosing price's currency, for example a resort fee payable at the property in its local currency. Absent means the enclosing price's currency, as before; a line inside the total never carries it.
- previousPenaltyMoneyOptional
  Integer minor units + ISO-4217, never floats (platform law)
  5 child attributes
  - amountintegerRequired
    Minor units
  - currencystringRequired
    ISO-4217
  - fxAppliedbooleanOptional
    True when the amount was converted from the supplier's currency.
  - fxSnapshotIdstringOptional
    The exchange-rate snapshot the amount was converted with, fixed when the price was quoted.
  - breakdownarray of PriceBreakdownLineOptional
    Sell-side component lines summing to amount; the platform may send it empty.Show more
    Sell-side component lines summing to amount; the platform may send it empty. One line shape everywhere — the same PriceBreakdownLine the rule simulation answers. Never carries a supplier net.
    13 child attributes
    typestringRequired
    The kind of line, for example BASE, TAX, FEE or DISCOUNT.
    amountintegerRequired
    Minor units
    feeTypestringOptional
    For FEE lines produced by a FEE_LINE rule — the tenant's fee label
    labelstringOptional
    Display label in the request locale
    taxComponentstringOptional
    For GST / TAX lines — CGST | SGST | IGST | UTGST | CESS | VAT | SALES_TAX | OCCUPANCY_TAX; open string
    taxCodeTaxCodeOptional
    The statutory classification of a taxed line (SAC/HSN in India, VAT codes elsewhere)
    rateBasisPointsintegerOptional
    The tax or fee rate in basis points when the line is rate-based (1800 = 18%)
    collectedBystringOptional
    PLATFORM | SUPPLIER | PROPERTY — who takes the money; a non-PLATFORM line outside Offer.price is a pay-at-property disclosure
    payableAtstringOptional
    BOOKING | PROPERTY | DESK | AFTER_SERVICE
    includedbooleanOptional
    True when the line is inside the enclosing amount (default); false for a disclosed line outside it
    quantityintegerOptional
    How many units the line covers, when more than one.
    unitAmountintegerOptional
    Minor units per unit when quantity is given
    currencystringOptional
    ISO-4217 code of this line's amount and unitAmount.Show more
    ISO-4217 code of this line's amount and unitAmount. Set ONLY on a disclosed line (included false) that is NOT in the enclosing price's currency, for example a resort fee payable at the property in its local currency. Absent means the enclosing price's currency, as before; a line inside the total never carries it.
- penaltyMoneyOptional
  Integer minor units + ISO-4217, never floats (platform law)
  5 child attributes
  - amountintegerRequired
    Minor units
  - currencystringRequired
    ISO-4217
  - fxAppliedbooleanOptional
    True when the amount was converted from the supplier's currency.
  - fxSnapshotIdstringOptional
    The exchange-rate snapshot the amount was converted with, fixed when the price was quoted.
  - breakdownarray of PriceBreakdownLineOptional
    Sell-side component lines summing to amount; the platform may send it empty.Show more
    Sell-side component lines summing to amount; the platform may send it empty. One line shape everywhere — the same PriceBreakdownLine the rule simulation answers. Never carries a supplier net.
    13 child attributes
    typestringRequired
    The kind of line, for example BASE, TAX, FEE or DISCOUNT.
    amountintegerRequired
    Minor units
    feeTypestringOptional
    For FEE lines produced by a FEE_LINE rule — the tenant's fee label
    labelstringOptional
    Display label in the request locale
    taxComponentstringOptional
    For GST / TAX lines — CGST | SGST | IGST | UTGST | CESS | VAT | SALES_TAX | OCCUPANCY_TAX; open string
    taxCodeTaxCodeOptional
    The statutory classification of a taxed line (SAC/HSN in India, VAT codes elsewhere)
    rateBasisPointsintegerOptional
    The tax or fee rate in basis points when the line is rate-based (1800 = 18%)
    collectedBystringOptional
    PLATFORM | SUPPLIER | PROPERTY — who takes the money; a non-PLATFORM line outside Offer.price is a pay-at-property disclosure
    payableAtstringOptional
    BOOKING | PROPERTY | DESK | AFTER_SERVICE
    includedbooleanOptional
    True when the line is inside the enclosing amount (default); false for a disclosed line outside it
    quantityintegerOptional
    How many units the line covers, when more than one.
    unitAmountintegerOptional
    Minor units per unit when quantity is given
    currencystringOptional
    ISO-4217 code of this line's amount and unitAmount.Show more
    ISO-4217 code of this line's amount and unitAmount. Set ONLY on a disclosed line (included false) that is NOT in the enclosing price's currency, for example a resort fee payable at the property in its local currency. Absent means the enclosing price's currency, as before; a line inside the total never carries it.
- snapshotPenaltyMoneyOptional
  Integer minor units + ISO-4217, never floats (platform law)
  5 child attributes
  - amountintegerRequired
    Minor units
  - currencystringRequired
    ISO-4217
  - fxAppliedbooleanOptional
    True when the amount was converted from the supplier's currency.
  - fxSnapshotIdstringOptional
    The exchange-rate snapshot the amount was converted with, fixed when the price was quoted.
  - breakdownarray of PriceBreakdownLineOptional
    Sell-side component lines summing to amount; the platform may send it empty.Show more
    Sell-side component lines summing to amount; the platform may send it empty. One line shape everywhere — the same PriceBreakdownLine the rule simulation answers. Never carries a supplier net.
    13 child attributes
    typestringRequired
    The kind of line, for example BASE, TAX, FEE or DISCOUNT.
    amountintegerRequired
    Minor units
    feeTypestringOptional
    For FEE lines produced by a FEE_LINE rule — the tenant's fee label
    labelstringOptional
    Display label in the request locale
    taxComponentstringOptional
    For GST / TAX lines — CGST | SGST | IGST | UTGST | CESS | VAT | SALES_TAX | OCCUPANCY_TAX; open string
    taxCodeTaxCodeOptional
    The statutory classification of a taxed line (SAC/HSN in India, VAT codes elsewhere)
    rateBasisPointsintegerOptional
    The tax or fee rate in basis points when the line is rate-based (1800 = 18%)
    collectedBystringOptional
    PLATFORM | SUPPLIER | PROPERTY — who takes the money; a non-PLATFORM line outside Offer.price is a pay-at-property disclosure
    payableAtstringOptional
    BOOKING | PROPERTY | DESK | AFTER_SERVICE
    includedbooleanOptional
    True when the line is inside the enclosing amount (default); false for a disclosed line outside it
    quantityintegerOptional
    How many units the line covers, when more than one.
    unitAmountintegerOptional
    Minor units per unit when quantity is given
    currencystringOptional
    ISO-4217 code of this line's amount and unitAmount.Show more
    ISO-4217 code of this line's amount and unitAmount. Set ONLY on a disclosed line (included false) that is NOT in the enclosing price's currency, for example a resort fee payable at the property in its local currency. Absent means the enclosing price's currency, as before; a line inside the total never carries it.
- supplierPenaltyMoneyOptional
  Integer minor units + ISO-4217, never floats (platform law)
  5 child attributes
  - amountintegerRequired
    Minor units
  - currencystringRequired
    ISO-4217
  - fxAppliedbooleanOptional
    True when the amount was converted from the supplier's currency.
  - fxSnapshotIdstringOptional
    The exchange-rate snapshot the amount was converted with, fixed when the price was quoted.
  - breakdownarray of PriceBreakdownLineOptional
    Sell-side component lines summing to amount; the platform may send it empty.Show more
    Sell-side component lines summing to amount; the platform may send it empty. One line shape everywhere — the same PriceBreakdownLine the rule simulation answers. Never carries a supplier net.
    13 child attributes
    typestringRequired
    The kind of line, for example BASE, TAX, FEE or DISCOUNT.
    amountintegerRequired
    Minor units
    feeTypestringOptional
    For FEE lines produced by a FEE_LINE rule — the tenant's fee label
    labelstringOptional
    Display label in the request locale
    taxComponentstringOptional
    For GST / TAX lines — CGST | SGST | IGST | UTGST | CESS | VAT | SALES_TAX | OCCUPANCY_TAX; open string
    taxCodeTaxCodeOptional
    The statutory classification of a taxed line (SAC/HSN in India, VAT codes elsewhere)
    rateBasisPointsintegerOptional
    The tax or fee rate in basis points when the line is rate-based (1800 = 18%)
    collectedBystringOptional
    PLATFORM | SUPPLIER | PROPERTY — who takes the money; a non-PLATFORM line outside Offer.price is a pay-at-property disclosure
    payableAtstringOptional
    BOOKING | PROPERTY | DESK | AFTER_SERVICE
    includedbooleanOptional
    True when the line is inside the enclosing amount (default); false for a disclosed line outside it
    quantityintegerOptional
    How many units the line covers, when more than one.
    unitAmountintegerOptional
    Minor units per unit when quantity is given
    currencystringOptional
    ISO-4217 code of this line's amount and unitAmount.Show more
    ISO-4217 code of this line's amount and unitAmount. Set ONLY on a disclosed line (included false) that is NOT in the enclosing price's currency, for example a resort fee payable at the property in its local currency. Absent means the enclosing price's currency, as before; a line inside the total never carries it.
- statestringOptional
- linksobjectOptional
- acceptedarray of stringOptional
- orderRefstringOptional
- retryAfterMsintegerOptional
- capMoneyOptional
  Integer minor units + ISO-4217, never floats (platform law)
  5 child attributes
  - amountintegerRequired
    Minor units
  - currencystringRequired
    ISO-4217
  - fxAppliedbooleanOptional
    True when the amount was converted from the supplier's currency.
  - fxSnapshotIdstringOptional
    The exchange-rate snapshot the amount was converted with, fixed when the price was quoted.
  - breakdownarray of PriceBreakdownLineOptional
    Sell-side component lines summing to amount; the platform may send it empty.Show more
    Sell-side component lines summing to amount; the platform may send it empty. One line shape everywhere — the same PriceBreakdownLine the rule simulation answers. Never carries a supplier net.
    13 child attributes
    typestringRequired
    The kind of line, for example BASE, TAX, FEE or DISCOUNT.
    amountintegerRequired
    Minor units
    feeTypestringOptional
    For FEE lines produced by a FEE_LINE rule — the tenant's fee label
    labelstringOptional
    Display label in the request locale
    taxComponentstringOptional
    For GST / TAX lines — CGST | SGST | IGST | UTGST | CESS | VAT | SALES_TAX | OCCUPANCY_TAX; open string
    taxCodeTaxCodeOptional
    The statutory classification of a taxed line (SAC/HSN in India, VAT codes elsewhere)
    rateBasisPointsintegerOptional
    The tax or fee rate in basis points when the line is rate-based (1800 = 18%)
    collectedBystringOptional
    PLATFORM | SUPPLIER | PROPERTY — who takes the money; a non-PLATFORM line outside Offer.price is a pay-at-property disclosure
    payableAtstringOptional
    BOOKING | PROPERTY | DESK | AFTER_SERVICE
    includedbooleanOptional
    True when the line is inside the enclosing amount (default); false for a disclosed line outside it
    quantityintegerOptional
    How many units the line covers, when more than one.
    unitAmountintegerOptional
    Minor units per unit when quantity is given
    currencystringOptional
    ISO-4217 code of this line's amount and unitAmount.Show more
    ISO-4217 code of this line's amount and unitAmount. Set ONLY on a disclosed line (included false) that is NOT in the enclosing price's currency, for example a resort fee payable at the property in its local currency. Absent means the enclosing price's currency, as before; a line inside the total never carries it.
- usedTodayMoneyOptional
  Integer minor units + ISO-4217, never floats (platform law)
  5 child attributes
  - amountintegerRequired
    Minor units
  - currencystringRequired
    ISO-4217
  - fxAppliedbooleanOptional
    True when the amount was converted from the supplier's currency.
  - fxSnapshotIdstringOptional
    The exchange-rate snapshot the amount was converted with, fixed when the price was quoted.
  - breakdownarray of PriceBreakdownLineOptional
    Sell-side component lines summing to amount; the platform may send it empty.Show more
    Sell-side component lines summing to amount; the platform may send it empty. One line shape everywhere — the same PriceBreakdownLine the rule simulation answers. Never carries a supplier net.
    13 child attributes
    typestringRequired
    The kind of line, for example BASE, TAX, FEE or DISCOUNT.
    amountintegerRequired
    Minor units
    feeTypestringOptional
    For FEE lines produced by a FEE_LINE rule — the tenant's fee label
    labelstringOptional
    Display label in the request locale
    taxComponentstringOptional
    For GST / TAX lines — CGST | SGST | IGST | UTGST | CESS | VAT | SALES_TAX | OCCUPANCY_TAX; open string
    taxCodeTaxCodeOptional
    The statutory classification of a taxed line (SAC/HSN in India, VAT codes elsewhere)
    rateBasisPointsintegerOptional
    The tax or fee rate in basis points when the line is rate-based (1800 = 18%)
    collectedBystringOptional
    PLATFORM | SUPPLIER | PROPERTY — who takes the money; a non-PLATFORM line outside Offer.price is a pay-at-property disclosure
    payableAtstringOptional
    BOOKING | PROPERTY | DESK | AFTER_SERVICE
    includedbooleanOptional
    True when the line is inside the enclosing amount (default); false for a disclosed line outside it
    quantityintegerOptional
    How many units the line covers, when more than one.
    unitAmountintegerOptional
    Minor units per unit when quantity is given
    currencystringOptional
    ISO-4217 code of this line's amount and unitAmount.Show more
    ISO-4217 code of this line's amount and unitAmount. Set ONLY on a disclosed line (included false) that is NOT in the enclosing price's currency, for example a resort fee payable at the property in its local currency. Absent means the enclosing price's currency, as before; a line inside the total never carries it.
- resetAtstring · date-timeOptional
- dimensionsarray of stringOptional
  SCOPE_WIDENING — the request members wider than the minting key (or the key's current scope)
- resumeBystringOptional
  KEY_PAUSED, LOOP_DETECTED — who can resume the key; owner (an Owner or Admin)
- consoleLinkstring · uriOptional
  KEY_PAUSED, LOOP_DETECTED — the console page of the key
- evidenceApiKeyPauseEvidenceOptional
  Why a key was paused. rule is LOOP_IDENTICAL (identical requests, path and body hash, per minute) | LOOP_HOLDS (holds without a booking or release in 10 minutes) | VELOCITY_HARD (the third soft breach…Show more
  Why a key was paused. rule is LOOP_IDENTICAL (identical requests, path and body hash, per minute) | LOOP_HOLDS (holds without a booking or release in 10 minutes) | VELOCITY_HARD (the third soft breach in 24 hours) | VELOCITY_BURST (above 5× a limit) | MANUAL (an Owner or Admin) | STOP_IGNORED (calls kept coming after stop), x-extensible-enum. summary is the line the console shows ("212 holds in 9 min"); requestIds are the traceIds of the requests that tripped the rule.
  8 child attributes
  - rulestringRequired
  - dimensionstringOptional
    The scope or threshold that tripped (reqPerSec, holdsPerHour, identicalRequestsPerMinute …); null for MANUAL
  - observedintegerOptional
  - limitintegerOptional
  - windowSecondsintegerOptional
  - summarystringRequired
  - requestIdsarray of stringRequired
  - atstring · date-timeRequired
- windowSecondsintegerOptional
  VELOCITY_LIMIT, SIGNUP_RATE_LIMITED — the window the limit is counted over
- openarray of stringOptional
  on 409 CONFLICT PREREQUISITES_OPEN, the keys of the required rail steps that are not done, in rail order
- countrystringOptional
  on 409 CONFLICT COUNTRY_NOT_LIVE, the tenant's country (ISO 3166-1 alpha-2) for which live bookings are not open yet
- missingTestCallsarray of GoLiveMissingTestCallsOptional
  on 409 CONFLICT GO_LIVE_TEST_CALLS_MISSING (POST /ops/v1/approvals/{id}:approve of a GO_LIVE_REVIEW), each requested product whose test_calls check is not passed and the verbs (search, reprice,…Show more
  on 409 CONFLICT GO_LIVE_TEST_CALLS_MISSING (POST /ops/v1/approvals/{id}:approve of a GO_LIVE_REVIEW), each requested product whose test_calls check is not passed and the verbs (search, reprice, orders, cancel) not yet seen in the tenant's sandbox
  2 child attributes
  - productstringRequired
  - verbsarray of stringRequired