Overview
Registrars can programmatically retrieve their account balance and credit status via a simple HTTP GET request to the Registrar Console API.
Balance API Endpoint
URL: https://registrar-console.registry.co/json/balance
Authentication: HTTP Basic authentication using your Registrar ID and EPP password.
Method: HTTP GET
Response Fields
- availableCredit — total credit available to fund registrations, renewals, and transfers (includes any emergency credit).
- balance — current prepaid balance. A negative value means the prepaid balance is exhausted.
- creditLimit — your credit limit. May be affected by emergency credit in case of unexpected balance exhaustion.
- creditThreshold — the balance level at which the Registry will send you an email alert to top up.
All values are in USD.
Account Settings API
A broader account settings endpoint is also available: https://registrar-console.registry.co/json/settings. This returns your organisation details, notification emails, billing configuration, EPP settings, and transfer preferences.
Use Case
Integrate the balance API into your monitoring system to alert your team when available credit falls below a threshold — before the Registry's own credit threshold alert triggers.
Related Articles
- How Does Billing Work in the .CO Registry?
- How to Submit Payment to the .CO Registry