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
Request
- Base URLhttps://api.crbonfree.com
- Auth
- HTTP bearer
- or API key in header X-API-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
Current retirement status
Changes
No recorded changes to this operation across all 17 revisions of this API.