Get Company Credits

​

Overview

​

Authentication

​

Example Request

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

const response = await fetch('/external-api/v1/company/credits', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json'
  }
});

const credits = await response.json();

​

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
}

{
  "error": true,
  "message": "Required scope \"company:read\" not found in token",
  "code": 403
}