Public

Public cost-dashboard projection (ADR-032)

Changed on

Unauthenticated. The vlx_pcd_… token in the URL is the sole credential — partners embed via iframe / fetch from their own app without an API key. Sanitized projection: customer_id, tenant_id, billing_period, subscriptions, usage[], totals, projected_total_cents. PII (email, display_name, external_id, metadata, billing_profile) is NEVER on this response. Wrong prefix or unknown token → 401 (anti-enumeration). No active sub → 200 with billing_period.source = "no_subscription" and empty arrays.

get/v1/public/cost-dashboard/{token}

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/public/cost-dashboard/{token}
  • Auth: HTTP bearer

Path parameters

tokenstring required

Response

Projection

customer_idstring
tenant_idstring
livemodeboolean
projected_total_centsinteger

Projected METERED cost for the current period, in cents. Recurring base fees are not included — an in_advance base is already invoiced at period open.

Changes