billing

Get Cost By Play

Aggregate unified-meter credits for one play in the caller's org.

Scoped to auth.org_id so callers can only see their own plays. Returns zero-filled response when no events have been recorded for the play (registered-but-unused plays are valid).

get/api/billing/cost-by-play

Request

  • Base URL
    https://platform.verbiflow.com/api/bridge
  • URL
    https://platform.verbiflow.com/api/bridge/api/billing/cost-by-play
  • Auth
    • HTTP bearer and API key in header x-flage-org-id
    • or HTTP bearer and API key in header x-flage-org-slug

Query parameters

play_idstring required

Response

Successful Response

credits_consumedstring required

Exact non-negative credit quantity in canonical decimal notation; no binary-float conversion is applied.

credits_reservedstring required

Exact non-negative credit quantity in canonical decimal notation; no binary-float conversion is applied.

credits_usedstring required

Exact non-negative credit quantity in canonical decimal notation; no binary-float conversion is applied.

event_countinteger required

Accounting events attributed to the Play.

is_partialboolean required

True when historical snapshots record positive credits but the Play has no ledger-attributed credits. False means this check found no gap; it does not certify complete attribution across mixed old and new runs.

partial_reasonstring nullable required

Reason ledger attribution is incomplete, when partial.

play_idstring required

Exact Workflow Play identifier.

scope'unified_credit_meter' required

Accounting scope used for every Play cost projection.

total_coststring required

Total credit cost; an alias of credits_used for this unified meter.

total_unitsstring required

Total credit units; an alias of credits_used for this unified meter.

usd_costnumber required

Projected USD equivalent at the workspace current overage-credit rate, rounded to six decimal places; this is not provider cost or an invoiced amount.

usd_per_creditnumber required

Current workspace overage-credit price in US dollars used for this projection; zero can mean a configured zero rate or unavailable commercial terms and does not prove that work is free.

Changes

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