Billing
Metered domain usage, plan, and quota for the caller's tenant
Metered domain usage, plan, and quota for the caller's tenant: CustomDomain™ API reference in the billing group. Covers parameters, request body and responses.
The tenant is derived from the authenticated credential, never a query parameter. ?period= defaults to the current UTC calendar month.
AuthorizationBearer <token>
Long-lived tenant API key, cd_live_… (production) or cd_test_… (staging, development), stored hashed. Keys created before the switch to cd_ start with sk_live_… / sk_test_… and are still accepted. Scoped to the owning application's tenant.
In: header
Query Parameters
period?string
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/billing/usage"{ "org": "string", "period": "2026-07", "used": 0, "mode": "test", "plan": "starter", "plan_name": "string", "quota": 0, "quota_used": 0, "quota_window_months": 0, "limit": 0, "metered": true, "hard_cap": true, "quota_state": "ok", "quota_enforced": true, "remaining": 0, "status": "string", "has_billing_account": true, "billing_state": "trialing"}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}