- Getting Started
- models
- authentication
- RootGET
- Privy AuthPOST
- Register UserPOST
- Request Password ResetPOST
- Reset PasswordPOST
- Get User BalanceGET
- User MonitorGET
- User Get Rate LimitsGET
- Get User Profile EndpointGET
- Update User Profile EndpointPUT
- Delete User Account EndpointDELETE
- Get Credit Transactions EndpointGET
- List User Api KeysGET
- Create User Api KeyPOST
- Update User Api Key EndpointPUT
- Delete User Api KeyDELETE
- Get User Api Key UsageGET
- Create Api KeyPOST
- Get User Audit LogsGET
- Get User Plan EndpointGET
- Get User Plan UsageGET
- Get User Plan EntitlementsGET
- Get User Environment UsageGET
- Get User Rate Limits AdvancedGET
- Update User Rate Limits AdvancedPUT
- Bulk Update User Rate LimitsPOST
- Get Api Key Rate Limit UsageGET
- Root
- admin
- Admin Add Credits
- Admin Get All Balances
- Admin Monitor
- Admin Set Rate Limit
- Admin Refresh Providers
- Admin Cache Status
- Admin Huggingface Cache Status
- Admin Refresh Huggingface Cache
- Admin Test Huggingface
- Admin Debug Models
- Admin Clear Rate Limit Cache
- Get Trial Analytics Admin
- Get All Users Info
- Get All Credit Transactions Admin
- Get User Info By Id
- Get Notification Stats
- Process Notifications
- Assign Plan To User
- Get System Rate Limits
- Get Rate Limit Alerts Endpoint
- Create Coupon Endpoint
- List Coupons Endpoint
- Get Coupon Endpoint
- Update Coupon Endpoint
- Deactivate Coupon Endpoint
- Get Coupon Analytics Endpoint
- Get Coupon Stats Endpoint
- Update Role
- Get User Role Info
- Get Audit Log
- List Users By Role
- Get Role Permissions Endpoint
- plans
- notifications
- trial
- subscription
- providers
- debug
- Stripe Payments
- chat
- chat-history
- ranking
- Activity
- coupons
- Analytics
- statistics
- comparison
- referral
- cache
- health
- Get System Health
- Get Providers Health
- Get Models Health
- Get Model Health
- Get Provider Health
- Get Health Summary
- Perform Health Check
- Perform Immediate Health Check
- Get Uptime Metrics
- Get Health Dashboard
- Get Health Status
- Get Monitoring Status
- Start Health Monitoring
- Stop Health Monitoring
- Check Google Vertex Health
- Trigger Gateway Fix
- Check All Gateways
- Gateway Health Dashboard
- Gateway Health Dashboard Data
- Check Single Gateway
- images
- analytics
- availability
- Health CheckGET
- PingGET
- Ping StatsGET
- Get Modelz ModelsGET
- Get Modelz Model Ids EndpointGET
- Check Model On ModelzGET
- Get Optimization HealthGET
- Get Connection Pool StatsGET
- Get Cache HealthGET
- Get Prioritization StatsGET
- Clear CachePOST
- Schemas
- AddCreditsRequest
- AssignPlanRequest
- AnthropicMessage
- AnalyticsEvent
- AuthMethod
- CreateApiKeyRequest
- ChatMessage
- AvailableCouponResponse
- DeleteAccountRequest
- ChatSession
- DeleteAccountResponse
- ChatSessionResponse
- AvailabilityStatus
- DeleteApiKeyRequest
- ChatSessionStatsResponse
- HTTPValidationError
- NotificationPreferences
- ChatSessionsListResponse
- NotificationStats
- PlanEntitlementsResponse
- NotificationType
- CreateChatSessionRequest
- CouponAnalyticsResponse
- PlanResponse
- CreateCheckoutSessionRequest
- CouponResponse
- ContentBlock
- PlanUsageResponse
- CreatePaymentIntentRequest
- CouponScope
- CreateRefundRequest
- CouponStatsResponse
- CircuitBreakerState
- PrivyAuthRequest
- CouponType
- PrivyAuthResponse
- PrivyLinkedAccount
- UpdateApiKeyRequest
- PrivyUserData
- UserPlanResponse
- Message
- CreateCouponRequest
- UserProfileResponse
- UpdateNotificationPreferencesRequest
- UserProfileUpdate
- ValidationError
- InputMessage
- ListCouponsResponse
- CreateSubscriptionCheckoutRequest
- ImageData
- ProxyRequest
- ImageGenerationRequest
- RateLimitConfig
- MessagesRequest
- ImageGenerationResponse
- SearchChatSessionsRequest
- HealthCheckRequest
- SetRateLimitRequest
- HealthDashboardResponse
- StripeCurrency
- HealthStatus
- StripePaymentMethodType
- HealthSummaryResponse
- SubscriptionStatus
- UpdateChatSessionRequest
- RedeemCouponRequest
- RedemptionHistoryItem
- UserRegistrationRequest
- RedemptionHistoryResponse
- ModelAvailability
- UserRegistrationResponse
- RedemptionResponse
- ModelHealthResponse
- ResponseFormat
- ModelStatusResponse
- ResponseFormatType
- ResponseRequest
- RoleAuditLogResponse
- ReferralStatsResponse
- RoleResponse
- SaveChatMessageRequest
- ProviderHealthResponse
- ProviderStatus
- UpdateCouponRequest
- ProviderStatusResponse
- UpdateRoleRequest
- ValidateReferralRequest
- ValidateReferralResponse
- SystemHealthResponse
- UptimeMetricsResponse
Get User Balance
GET
https://api.gatewayz.ai/user/balance
Request
Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************or
Responses
🟢200OK
application/json
Body
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.gatewayz.ai/user/balance' \
--header 'Authorization: Bearer <token>'Response Response Example
nullModified at 2025-11-07 03:16:43