Overview
This guide will walk you through the process of purchasing fax numbers through the Fax.Plus API. You'll learn how to check your balance, find available numbers, and complete the purchase process.
Prerequisites
- An active Fax.Plus Enterprise account
- API access credentials
- Sufficient account balance for the purchase
Step-by-Step Guide
-
Check your account balance
Before starting the purchase process, verify that you have sufficient funds in your account. The Fax.Plus API only uses your account balance for purchases.GET /v3/shop/balance
Response example:{
Learn more: Get account balance - Fax.Plus API
"amount": 100,
"currency": "USD"
}
Tip: Make sure your balance covers the cost of the number you want to purchase. If you need to add funds, visit app.fax.plus
-
View available countries
GET /v3/shop/numbers/countries
Learn more: List countries - Fax.Plus API
Currently, fax numbers via Fax.Plus API are available in the:
- 🇺🇸 United States
- 🇨🇦 Canada
-
Find available areas
Once you've selected a country, you can view available geographic areas where fax numbers can be purchased.GET /v3/shop/numbers/countries/{country_code}/areas
Example for US areas:GET /v3/shop/numbers/countries/US/areas
Learn more: List areas - Fax.Plus API -
Search for available numbers
Search for fax numbers using country and area filters:GET /v3/shop/numbers/countries/{country_code}/areas/{calling_code}/numbers
Example search for numbers in New York (area code 212):GET /v3/shop/numbers/countries/US/areas/212/numbers
Learn more: List available numbers - Fax.Plus API -
Purchase a number
Once you've found your desired number, you can purchase it immediately:POST /v3/shop/numbers/purchase
Body{
Response
"item_id": "<string>"
}{
"number": "<string>"
}
Important Notes
- Balance Requirement: Ensure you have sufficient balance before attempting a purchase.
- Geographic Availability: Numbers are currently only available in the US and Canada.
- Payment Method: Purchases are only processed using your account balance.
- Failed Purchases: If your balance is insufficient, the purchase will fail.
Learn more: Purchase a number - Fax.Plus API
Troubleshooting
Common issues and solutions
-
Insufficient balance
- Solution: Add funds through the app.fax.plus web interface.
- Number no longer available
- Solution: Numbers are allocated in real time. If a purchase fails because the number is no longer available, perform a new search and try with a different number.
- Invalid area code
- Solution: Double-check the area code using the areas endpoint before searching for numbers.