Skip to content
eSIM Go Developer Docs

Balance Notification

POST
BalanceThreshold

Balance notifications will alert you when you have insufficient credit to purchase a bundle or have reached your Org Balance Alert Threshold. The Org Balance Alert Threshold is set by default to $100 and can be updated in the eSIM Go Management Portal under Settings. These alerts can be used to ensure you keep your account in credit and to monitor for any unexpected or untoward patterns of bundle purchases..

The alertType for these notifications will be LowBalance, except for when a transaction is rejected due to insufficient balance, when it will be InsufficientBalance.

Alerts will be triggered on

  • Reaching the Org Balance Alert Threshold
  • On passing 75% of the threshold
  • On passing 50% of the threshold
  • On passing 10% of the threshold
  • On purchase attempts failing due to lack of credit (Sent up to 10 times, with alertType of InsufficientBalance)

Request Body required

object
alertType

Type of alert (“LowBalance” or “InsufficientBalance”)

string
balanceInfo
object
balance

Current balance remaining ($)

number
1299.3
threshold

The Organisation’s “low balance” threshold, configurable in portal

number
2600
thresholdPercentRemaining

Percentage balance remaining of the Organisation’s “low balance” threshold

number
1000000000
Examples
{
  "alertType": "LowBalance",
  "balanceInfo": {
    "balance": 1299.3,
    "threshold": 2600,
    "thresholdPercentRemaining": 49.973
  }
}

Responses

None

No response body