GET /balance is read-only and requires no product resource or provisioning step.
Before starting
- Create a key from API Keys in Mission Control Portal. See Create and manage API keys for storage and rotation guidance.
- Install
curlon macOS or Linux, or use PowerShell on Windows. - Keep the key in a server-side environment variable. Never embed it in browser or mobile code.
Send the request
- macOS and Linux
- Windows PowerShell
Request failed?Start with API troubleshooting, then check authentication and the API error catalog.
data object containing the current balance, pending amount, credit limit, available credit, and ISO 4217 currency identifier:
Interpret failures
401 Unauthorized: TheAuthorizationheader is absent or the key is invalid.403 Forbidden: The credential or account cannot access balance information.422 Unprocessable Entity: The request reached the endpoint but could not be processed.503 Service Unavailable: The service is temporarily unavailable. Apply the retry guidance.