v3

latestOpenAPI 3.1.02026-07-31121332.1 KB
Billing

Get carbon retirement status

Customer-facing snapshot of the current billing period's carbon-retirement lifecycle: a translated status (collecting → calculating → awaiting_payment → retiring → retired / pending_signature / action_required), the period's carbon + electricity totals, the amount charged, and a receipt summary (null until credits are retired). Scoped to the authenticated organization. 404 when the org has no periods yet.

get/api/v1/billing/retirement-status

Response

Current retirement status

successtrue required