EstimateResponse
A free, priced quote for exactly this request. Returned in place of the normal 200 body when estimate=true; nothing is reserved and nothing reaches the store.
Type: object.
| Name | Type | Description |
|---|---|---|
estimate required | CostBreakdown | |
requestId required | string | |
fields | array of string | The resolved field projection the quote was priced for (field-priced endpoints only). |
priceSource | string | Which layer priced the quote: default (the endpoint's list price, as published in this document), plan (the store's plan carries its own price for this endpoint), subscription (a price agreed for this store), or house (a CompuDime-owned integration, priced at zero). store is the legacy value while billing reports no layer. One of: default, plan, subscription, house, store. |
quantity | integer | Per-row and per-page endpoints only: on unit row the page bound of exactly this request (its effective limit, or the day count of a daily range), the most rows the real call can return; on unit page the pages of 100 rows that bound fills, rounded up. |
totalCredits | integer | Per-row and per-page endpoints only: estimate.totalCredits times quantity, the most the real call can cost. It is an upper bound: the real call settles down to the rows it returns (or the pages they fill), and an empty page costs nothing. |
unit | string | Present only when billing prices this endpoint per row or per page: estimate then prices ONE row (or one page of 100 rows), and quantity and totalCredits give the call. Absent on a per-request endpoint, whose estimate is the whole call. One of: row, page. |
No other fields appear.