BillingFox API

Getting Started


  • BillingFox is a usage based billing service built to be the fastest, easiest and simplest way to get paid for just about anything.

Implement our API by setting up actions within your service and then assigning worth to those actions via spend calls to BillingFox. Open this page, watch that video, call the other API. Whatever. Just correlate those actions to spending a user's BillingFox credits. 2 credits here, 10 credits there, 0.073 credits everywhere. You decide. When a user's balance starts getting low and hits your alert level we'll send them an email invoice to refill their account. Once they fill out that invoice we'll credit their balance, subtract the fees and pass on the rest to you.

As a concrete example, if a user were to fill out a $25 invoice

  • Stripe would take out 2.9% + $0.3 = $1.03
  • BillingFox would take out 5% = $1.25
  • The user would receive 2,500 credits
  • Leaving you with $22.72

+BillingFox FAQs 
Email Us
 

Authentication

Once you've created and signed into your BillingFox account you'll be presented with a screen containing your access token.
You'll simply need to include that token as an Authorization header with the Bearer prefix.
Once you've got that set you're ready to run with the BillingFox API!
 

Live and Test Networks

The BillingFox API has a concept of live and test networks. For all testing you should be hitting the test.billingfox.com  and only once you’re in production should you be using live.billingfox.com
 

Errors

All errors are in the format:
{ // 400
    "message": "Unauthorized. Access token is invalid",
    "status": "error"
}
or
{ // 402
    "message": "Insufficient available balance to spend 5 credits",
    "status": "process"
}
 

API

Ping

  • Test your access token and get some basic details on your account
GET /ping

curl --request GET \
  --url https://test.billingfox.com/api/ping \
  --header 'accept: application/json' \
  --header 'authorization: Bearer YOUR API KEY HERE'

{ // 200 Success