buzzabout docs
API referenceEndpoints

Prices

GET /v1/prices — live credit prices and billing metadata, alongside unchanged USD compatibility prices.

GET /v1/prices returns the calling account's stored prices for the four public data categories. Use prices_credits for credit usage and billing for presentation mode, redemption rate and precision. Existing prices, rate and currency remain USD compatibility fields.

One price endpoint

This is a free read. The removed GET /v1/credit_prices route is not restored; both units are available through GET /v1/prices. The map is named prices_credits, not credit_prices.

Endpoint

GET
/v1/prices

Authorization

ApiKeyAuth
x-api-key<token>

Buzzabout API key, beginning with bz_live_ (or bz_test_ for staging-only keys).

In: header

Response Body

application/json

curl -X GET "https://example.com/v1/prices"
{
  "status": "info",
  "data": {
    "billing": {
      "catalog_version": "2026-09-15",
      "credit_rate_usd": "0.007000",
      "precision": 6,
      "unit": "credits"
    },
    "currency": "usd",
    "prices": {
      "audience_profile": 0.021,
      "mention": 0.007,
      "post_processing": 0.0035,
      "preview_generation": 0.007
    },
    "prices_credits": {
      "audience_profile": "3.000000",
      "mention": "1.000000",
      "post_processing": "0.500000",
      "preview_generation": "1.000000"
    },
    "rate": 0.007
  }
}

Response

{
  "status": "success",
  "data": {
    "prices_credits": {
      "mention": "1.000000",
      "audience_profile": "3.000000",
      "post_processing": "0.500000",
      "preview_generation": "1.000000"
    },
    "billing": {
      "unit": "credits",
      "credit_rate_usd": "0.007000",
      "catalog_version": "2026-09-15",
      "precision": 6
    },
    "currency": "usd",
    "rate": 0.007,
    "prices": {
      "mention": 0.007,
      "audience_profile": 0.021,
      "post_processing": 0.0035,
      "preview_generation": 0.007
    }
  }
}

prices_credits values are six-decimal strings or null. Each comes from the stored category USD price divided by the server-resolved billing.credit_rate_usd. Ordinary registered plans use 1 credit per mention, 3 per audience profile, 0.5 per processed post and 1 per preview source. Read live category prices rather than guessing from a tier name or multiplying a legacy rate yourself.

billing.unit is credits or usd; credit_rate_usd remains a decimal USD-per-credit string. catalog_version and precision are returned with the projection. The example's 0.5-credit processed post has a canonical USD price of $0.0035, not $0.00.

Unavailable contract terms

A missing category price returns null, not zero or free. billing can be null when current credit terms are unavailable, with null credit category values; existing USD prices remain readable. The prices_credits block itself is nullable in the public schema, so clients must handle that too. Missing terms are never permission to start unpriced work.

Legacy rate is a numeric USD-per-unit compatibility field and can be null on category-priced contract plans. currency: "usd" describes the USD fields, not prices_credits. These current projections are not historical event quotes: captured history keeps its own rate.

What these prices cover

mention covers dataset runs and modern listening-agent collection. audience_profile covers profile collection, not a separate legacy audience-insights generation action. post_processing covers custom parameter and pattern detection processing. Public research previews charge preview_generation per source; URL previews refund empty sources. AI Ask and MCP natural-language Query charge variable inference separately, not a fifth fixed category price in this map.

Keep full decimal precision for arithmetic and round only at display. Do not render a positive small charge as zero or use display rounding to determine affordable work.

Next steps

On this page