GET
/
external-api
/
v1
/
company
/
credits
Get Company Credits
curl --request GET \
  --url https://getbill.io/external-api/v1/company/credits \
  --header 'Authorization: <authorization>'
{
  "error": false,
  "message": "Success",
  "data": {
    "current_credits": 847,
    "subscription": {
      "plan": "Professional",
      "status": "active",
      "expires_at": "2024-02-15T23:59:59Z"
    }
  }
}

​
Overview

This endpoint returns information about your company’s credit balance, usage, and subscription details. Credits are used for various operations like making calls and sending SMS. Email campaigns are free and do not consume credits.

​
Authentication

Requires a valid OAuth 2.0 access token with the company:read scope.

​
Request

​
Authorization
string
required
Bearer token for authentication

​
Example Request

curl -X GET "/external-api/v1/company/credits" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

​
Response

​
error
boolean
Always false for successful requests
​
message
string
Success message
​
data
object
Credit and subscription information

​
Success Response

{
  "error": false,
  "message": "Success",
  "data": {
    "current_credits": 847,
    "subscription": {
      "plan": "Professional",
      "status": "active",
      "expires_at": "2024-02-15T23:59:59Z"
    }
  }
}

​
Usage Notes

  • Credits are typically refreshed monthly based on your subscription plan
  • Different operations consume different amounts of credits:
    • Phone calls: 1-5 credits depending on duration
    • SMS messages: 1 credit per message
    • Email campaigns: 0 credits (free)
    • WhatsApp messages: 1-2 credits per message
  • Monitor your credit usage to avoid service interruptions
  • Contact support to upgrade your plan if you need more credits

​
Error Responses

{
  "error": true,
  "message": "Authentication credentials are missing or invalid",
  "code": 401
}