2 months ago

Feature: add Partner API - get credit balance

Partner API — Get Credit Balance
A new Partner API endpoint allows partners to programmatically retrieve their current credit balance — useful for automated billing monitoring, low-credit alerts, and partner dashboard integrations.
New Endpoint
MethodEndpointDescriptionGET | /partner/credit-balance | Get the partner's current credit balance
Response
{
  "credit": "string",
  "status": "ok"
}
Scope Required
Manage Team
No Parameters Required
This is a simple GET request — no request body or query parameters needed. Just authenticate with your Partner API key and call the endpoint.
Use Cases
  • Automated low-credit alerts — poll the endpoint periodically and send a notification when credit drops below a threshold
  • Partner billing dashboards — display live credit balance in a custom partner portal or internal tool
  • n8n / Zapier automations — trigger a top-up workflow or Slack alert when credit is running low
  • Pairs with the existing POST /partner/workspace/{workspaceId}/topup-points endpoint for a full credit management automation loop (check balance → top up if needed)
Why It Matters
  • Partners managing multiple workspaces need visibility into their credit balance to avoid service interruptions
  • Enables proactive credit management without requiring manual login to the Partner dashboard
  • Simple, no-parameter endpoint makes it easy to integrate into any monitoring or automation system
👉 Located at: Partner API Docs → Partner Management → GET /partner/credit-balance Full docs: uchat.com.au/partner-api#/Partner Management Published: March 24, 2026