Gets the plan, limits, usage and subscription state
GET/api/v1/billing
Read-only: purchases, plan changes, cancellation, card and add-on pack actions stay on the Creem checkout page (manage_url). Payment provider identifiers aren't returned. Needs admin permission. Scope: organization:read.
- Scope
organization:read- SDK method
- getBilling · get_billing
- MCP tool
getBillingread-only
Example request
curl -X GET "https://hiboty.com/api/v1/billing" \
-H "Authorization: Bearer $HIBOTY_API_KEY"Example response (200)
JSON
{
"data": {
"plan": "string",
"limits": {
"bots": 1,
"monthly_messages": 1,
"ai_replies": 1,
"seats": 1,
"workspaces": 1,
"campaigns": true,
"api": true,
"mini_apps": true,
"storage_mb": 1
},
"usage": {
"messages": 1,
"ai_replies": 1,
"bots": 1,
"seats": 1,
"storage_bytes": 1
},
"subscription": {
"status": "string",
"plan": "string",
"period": "string",
"current_period_end": "2026-11-06T09:00:00.000Z",
"canceled_at": "2026-11-06T09:00:00.000Z"
},
"ai_extra_credits": 1,
"price": {
"currency": "USD",
"monthly_amount_cents": 1,
"yearly_amount_cents": 1
},
"manage_url": "https://example.com/a.png"
}
}Possible errors
400Invalid request: a missing or wrong field, or an unknown field name (validation_error).401The API key is missing, invalid or revoked (unauthorized).403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.