Skip to main content
Endpoints for viewing and managing organization credits.
Base path: /credits
These endpoints are accessible by any authenticated user for their own organization.

Types

Get credit balance

Response:

Get credit transaction history

Response:

Credit Behavior

Cost Calculation

Credits are deducted per node execution during calls: SMS Program Billing: SMS programs (bulk campaigns) are billed at the same rate as SMS nodes:
  • 1.887 credits per message
  • Billed at campaign completion
  • Transaction type: sms_charge
  • Allows negative balance (send first, pay later)
Other services (future): Notes:
  • Unanswered calls (DIAL with no connection) are not charged
  • DIAL has minimum billing of 10 seconds (if answered)
  • Ongoing calls can push balance negative
  • Credits are deducted after call completion

Out of Credits Behavior

When an organization’s balance reaches zero or below:
  1. Running programs are paused with status paused_no_credits
  2. Queued calls are cancelled
  3. Ongoing calls are allowed to complete (balance may go negative)
  4. New call requests are rejected with InsufficientCreditsError
To resume operations:
  1. Credits are added to the organization
  2. Programs must be manually resumed via program management API