MessagingCreditsDto

The practice's messaging credits: one SMS segment or one WhatsApp message costs one credit. Read from the Messaging
Service each time; SodiumHQ keeps no copy.

Properties

Name Type Description
balanceinteger

Credits left

Credits left

autoTopUpMessagingAutoTopUpDto
lowCreditAlertBelowinteger

The balance below which the practice's messaging admins are told; null when off

The balance below which the practice's messaging admins are told; null when off

pricesMessagingCreditPricesDto
creditsUsedThisMonthinteger

Credits spent this calendar month (UTC), less any given back for a send that failed

Credits spent this calendar month (UTC), less any given back for a send that failed

JSON Example

{
  "balance": 0,
  "autoTopUp": {
    "below": 1,
    "blocks": 1,
    "monthlyCapBlocks": 1
  },
  "lowCreditAlertBelow": 0,
  "prices": {
    "numberMonthlyPence": 0,
    "creditBlockPence": 0,
    "creditsPerBlock": 0,
    "creditsPerSmsSegment": 0,
    "creditsPerWhatsAppMessage": 0
  },
  "creditsUsedThisMonth": 0
}

Used By Operations