{
"object": "billing_overview",
"live_balance": 123,
"test_balance": 123,
"currency": "<string>",
"plan_id": "<string>",
"live_credits": {
"permanent": 123,
"monthly": 123,
"reserved": 123,
"debt": 123,
"available": 123,
"expired": 123,
"next_expiration": "2023-11-07T05:31:56Z"
},
"test_credits": {
"permanent": 123,
"monthly": 123,
"reserved": 123,
"debt": 123,
"available": 123,
"expired": 123,
"next_expiration": "2023-11-07T05:31:56Z"
},
"subscription": {
"status": "<string>",
"paid_plan_id": "<string>",
"paid_until": "2023-11-07T05:31:56Z",
"cancel_at_period_end": true,
"organization_id": "<string>",
"stripe_subscription_id": "<string>",
"stripe_customer_id": "<string>",
"paid_price_id": "<string>",
"price_minor": 123,
"currency": "<string>",
"period_allowance": 123,
"concurrent_jobs": 123,
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z",
"scheduled_plan_id": "<string>",
"schedule_id": "<string>",
"recovery_url": "<string>",
"legacy_unsynced": true,
"updated_at": "2023-11-07T05:31:56Z"
},
"operations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "<string>",
"kind": "checkout",
"status": "preview",
"idempotency_key": "<string>",
"payment_amount": 123,
"extra_credits": 123,
"actor_id": "<string>",
"actor_type": "hub",
"reason": "<string>",
"target_price_id": "<string>",
"target_plan_id": "<string>",
"subscription_id": "<string>",
"proration_date": 123,
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"stripe_invoice_id": "<string>",
"stripe_checkout_session_id": "<string>",
"stripe_schedule_id": "<string>",
"recovery_url": "<string>",
"before": {},
"after": {},
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"billing_country": "<string>",
"auto_reload": {}
}Management
Platform administrator: read organisation billing overview
WEBHOOK
/
mgmt
/
v1
/
admin
/
organizations
/
{id}
/
billing
/
overview
{
"object": "billing_overview",
"live_balance": 123,
"test_balance": 123,
"currency": "<string>",
"plan_id": "<string>",
"live_credits": {
"permanent": 123,
"monthly": 123,
"reserved": 123,
"debt": 123,
"available": 123,
"expired": 123,
"next_expiration": "2023-11-07T05:31:56Z"
},
"test_credits": {
"permanent": 123,
"monthly": 123,
"reserved": 123,
"debt": 123,
"available": 123,
"expired": 123,
"next_expiration": "2023-11-07T05:31:56Z"
},
"subscription": {
"status": "<string>",
"paid_plan_id": "<string>",
"paid_until": "2023-11-07T05:31:56Z",
"cancel_at_period_end": true,
"organization_id": "<string>",
"stripe_subscription_id": "<string>",
"stripe_customer_id": "<string>",
"paid_price_id": "<string>",
"price_minor": 123,
"currency": "<string>",
"period_allowance": 123,
"concurrent_jobs": 123,
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z",
"scheduled_plan_id": "<string>",
"schedule_id": "<string>",
"recovery_url": "<string>",
"legacy_unsynced": true,
"updated_at": "2023-11-07T05:31:56Z"
},
"operations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "<string>",
"kind": "checkout",
"status": "preview",
"idempotency_key": "<string>",
"payment_amount": 123,
"extra_credits": 123,
"actor_id": "<string>",
"actor_type": "hub",
"reason": "<string>",
"target_price_id": "<string>",
"target_plan_id": "<string>",
"subscription_id": "<string>",
"proration_date": 123,
"period_start": "2023-11-07T05:31:56Z",
"period_end": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"stripe_invoice_id": "<string>",
"stripe_checkout_session_id": "<string>",
"stripe_schedule_id": "<string>",
"recovery_url": "<string>",
"before": {},
"after": {},
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"billing_country": "<string>",
"auto_reload": {}
}Authorizations
Short-lived JWT issued by the CarHub auth service (Better Auth), verified against its
JWKS. Claims: sub (user), org_id (active organisation) and role
(owner | admin | member | billing_manager). Used by the dashboard for /mgmt/v1/… only — it is never
accepted on /v1/….
Path Parameters
Response
Success
Allowed value:
"billing_overview"Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes