API referenceBilling
Whether billing needs attention (every member)
What the console needs on every page to decide on a billing banner or the setup flow. Any member of the workspace may read it with their own tenant API key. Members and viewers get only role, can_manage, configured, attention and restricted: never the plan, dates or amounts. Owners and admins also get the billing state, and first_domain_free while a new workspace is on the first domain free rule.
Authorization
apiKey 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
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/billing/notice"{ "role": "owner", "can_manage": true, "configured": true, "attention": true, "restricted": true, "setup_required": true, "first_domain_free": true, "state": "trialing", "reason": "string", "plan_id": "string", "plan_name": "string", "days_left": 0, "trial_ends_at": "2019-08-24T14:15:22Z", "grace_ends_at": "2019-08-24T14:15:22Z", "current_period_end": "2019-08-24T14:15:22Z", "cancel_at_period_end": true, "payment_failed": true}{ "code": "string", "title": "string", "details": "string"}{ "code": "string", "title": "string", "details": "string"}