GET
Get Company Credits

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

string
required
Bearer token for authentication

Example Request

Response

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

Success Response

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