Billing and plans
Understand plan limits, billing summary, checkout, portal, cancellation, and recovery endpoints.
Plan-controlled features
Workspaces have billing summary, entitlements, usage, dashboard overview, and permissions endpoints. The customer portal uses those to decide which features are available.
Plan changes should be handled through the customer billing routes so provider state, local subscription state, and entitlements stay aligned.
Usage and limits
Usage includes message count, sender count, API client count, automation count, template count, team count, and other workspace-level limits.
Applications should handle limit errors cleanly and guide operators to the billing page when a plan upgrade is required.
[
{
"status": 429,
"body": {
"error": "monthly_quota_exceeded",
"message": "Workspace monthly message quota has been reached."
}
},
{
"status": 403,
"body": {
"error": "plan_limit_reached",
"message": "Plan limit reached for this workspace resource."
}
},
{
"status": 403,
"body": {
"error": "OWN_NUMBER_OTP_REQUIRES_PRO",
"message": "Branded OTP from your own WhatsApp number is available on Pro and higher plans."
}
}
]Need help?
Use Book Integration Help if you want setup help for OTP or automated customer messaging.
Next steps
Quickstart
A practical path from empty workspace to a working server-side integration.
Authentication and access
HookMessage separates customer API keys, dashboard sessions, and internal platform access.
Workspaces
A workspace is the tenant boundary for every customer resource.
Senders and sessions
A sender is the WhatsApp number used to deliver messages for a workspace.