Deliveries

Delivery quote

Returns a price estimate for a proposed delivery without executing it. Provide the audience ID, destination, and optionally field_list or template_id (mutually exclusive) to receive a structured cost breakdown and credit balance information. If neither is provided, the audience fields are used, or audience plus feature-store fields for a pure matched composition. No delivery or charge is made. A fresh quote stores a pending quote and updates the audience's current quote reference and price; a completed re-export does not create another pending quote. Download is the currently active destination; LiveRamp and Narrative return 503 before a quote or billable record is created until their partner pushes are implemented. Returns two cost figures: cost_estimate is license-aware (identities this audience already holds an active 12-month license for elsewhere are excluded from the billable count) and max_cost_estimate is the worst-case ceiling assuming no identity is pre-licensed. See license_pricing.status for whether cost_estimate reflects a live or cached computation, or degraded non-blockingly to the max figure. Requires 'discovery' scope.

post/v1/quote

Request

  • Base URL: https://api.infiniteaudience.ai
  • URL: https://api.infiniteaudience.ai/v1/quote
  • Auth: HTTP bearer

Request body

audience_idstring required

ID of the audience to quote a delivery for.

destination'download' | 'liveramp' | 'narrative' required

Intended destination. liveramp and narrative currently return DELIVERY_DESTINATION_UNAVAILABLE without billing.

template_idstring nullable

Enrichment template ID. standard_iag is valid; standard_enrichment is valid for pure matched exports and matching. Mutually exclusive with field_list. If neither is provided, the enrichment set is used for pure matched output; otherwise the audience set is used.

field_liststring[] nullable

Explicit attribute list — every attribute must be a field allowed for this output (see GET /v1/catalog/fields). Mutually exclusive with template_id. If neither is provided, the enrichment set is used for pure matched output; otherwise the audience set is used.

include_unmatchedboolean

Include unmatched input rows in matched-audience output.

output_format'csv' | 'avro' | 'json' | 'jsonl'

Artifact format being quoted, independent of matched-input format.

output_compression'none' | 'gzip'

gzip is supported for csv/json/jsonl. Avro uses native DEFLATE and rejects outer gzip.

Response

Price quote — no commitment made.

audience_idstring required
subtype'filter' | 'matched' | 'similarity' | 'propensity' required
destinationstring required
template_idstring nullable required
field_liststring[] nullable required
output_format'csv' | 'avro' | 'json' | 'jsonl' required
output_compression'none' | 'gzip' required
already_deliveredboolean required

true if this billing identity (audience composition and segment revisions, resolved fields, unmatched-row policy, and destination) has already been delivered. Artifact format/compression are deliberately excluded, so changing only those axes permits a free re-export.

quote_idstring nullable required

ID of the persisted quote backing this estimate. null when already_delivered is true (a free re-delivery has no pending cost, so nothing is persisted).

record_countinteger required

Current audience size.

match_countinteger nullable required

matched subtype only — resolved rows from most recent delivery.

billing_model'prepay' | 'postpay' required

Resolved from the org's own billing_model, or 'postpay' for parent_billed (agency) orgs. Determines which of available_balance/shortfall vs. budget_ceiling/accrued_balance is populated below.

billing_authority'self' | 'agency' required

Whether the org or an agency owns this billing route.

available_balancenumber nullable required

Prepay only — effective credit balance after holds. Null for postpay/agency orgs, which have no credit balance.

sufficient_balanceboolean required

Prepay: whether available_balance ≥ total_cost. Postpay/agency: whether this delivery would stay within the org's/agency's optional budget ceiling (always true when no ceiling is set).

shortfallnumber nullable required

Prepay only — credits needed beyond current balance (0 when sufficient). Null for postpay/agency.

budget_ceilingnumber nullable required

Postpay/agency only — the org's configured budget ceiling in USD. Null if unset (unlimited) or for prepay.

accrued_balancenumber nullable required

Postpay/agency only — accrued USD spend so far this cycle. Null for prepay.

Changes

No recorded changes to this operation across all 1 revision of this API.