Quote an order
quote_orderCreates a machine quote for a count: the records you would receive after removing ones already held and suppressed, the credits and GBP price, the licence, the warranty and any blockers. The quote_id lasts 24 hours and is bound to the dataset version; it is not a human sales quote, which is a 14 day PDF made in the app. Free and needs no account, and nothing is charged. Show the credits and price to the user, then call create_order with the quote_id. Lawful basis is UK GDPR Article 6(1)(f) legitimate interests; email audiences include corporate subscribers only by default (PECR), so sole traders and ordinary partnerships are left out unless the toggle is changed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Records to buy; left out, the whole count. | |
| licence | No | multi_use_12m (12 month multi-use, every plan) or outright (1.8 credits a record, proposed). | multi_use_12m |
| count_id | Yes | A count id from POST /v1/counts or count_audience. Either case is accepted; responses use upper case. | |
| field_set | Yes | A field set id from GET /v1/field-sets, such as standard. | |
| connection_id | No | The CRM connection to check, only with dedupe_against crm or previous_orders_and_crm. | |
| dedupe_against | No | Remove records you already hold: from earlier orders, from a connected CRM, or both. Default previous_orders when signed in. crm and previous_orders_and_crm need connection_id. | previous_orders |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Format: a quote id: qte_ followed by a 26 character ULID in upper case Crockford base32, such as qte_01JB4M2R6T1Y5W8ZAK8Q2V7XN3. | |
| kind | Yes | ||
| dataset | No | The dataset an audience draws from. uk_contacts is live; ie_contacts and global_contacts are listed but not yet served. | |
| licence | Yes | ||
| records | Yes | Records after overlap and suppression; what you would receive. | |
| removed | Yes | Records left out and never charged. | |
| blockers | Yes | ||
| count_id | Yes | The count the quote was priced from. | |
| purchase | Yes | ||
| warranty | Yes | ||
| field_set | No | ||
| signature | Yes | ||
| created_at | No | ||
| expires_at | Yes | 24 hours after creation. | |
| gbp_ex_vat | Yes | What credits_required cost bought the cheapest way, at the per-contact scale or with credit packs, excluding VAT. The same for every caller; purchase says what this caller needs to buy. | |
| balance_after | Yes | credits_available less credits_required; negative means a top-up is needed; null when signed out. | |
| dataset_version | Yes | The immutable weekly build a count is bound to, such as 2026-W39. The last 52 stay queryable. | |
| organisation_id | Yes | The organisation the quote belongs to; create_order settles it only there. null for a quote made without an account, which the first organisation to confirm it takes. | |
| credits_required | Yes | records times credits_per_record (creditsFor). | |
| credits_available | Yes | Your balance; null when signed out. | |
| credits_per_record | Yes | 1 for a complete UK record; 1.8 outright (proposed). |