{
"reason": "<string>",
"confirmed": true,
"price_id": "<string>",
"preview_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"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"
}
Management
Platform administrator: cancel with an audit reason and confirmation
WEBHOOK
/
mgmt
/
v1
/
admin
/
organizations
/
{id}
/
billing
/
cancel
{
"reason": "<string>",
"confirmed": true,
"price_id": "<string>",
"preview_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"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"
}
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/….
Headers
Reuse the same key on network retries. Execute a change with the preview’s key.
Required string length:
1 - 200Path Parameters
Body
application/json
Response
Success
Available options:
checkout, upgrade, downgrade, cancel, resume, sync, grant Available options:
preview, pending, requires_action, completed, failed, expired, abandoned Available options:
hub, admin, system