Sample code for 30+ languages & platforms
Visual FoxPro Requires Chilkat v11.6.0+

Sinch Engage: Get a Prepaid Credit Balance

See more Sinch Engage Examples

Read the prepaid account credit balances. A balance field can be omitted when none is configured; do not treat absence as zero. Monetary prepaid SMS balances can be fractional, so the example displays the JSON value as text without converting it to an integer. Postpaid accounts may not expose this resource.

Sinch Engage is the renamed MessageMedia platform. This uses the Engage API, not Sinch Conversation API credentials or endpoints. Create an Engage API key/secret and place {"api_key":"YOUR_KEY","api_secret":"YOUR_SECRET"} in private sinch-engage.json. Select the account's regional HTTPS host: https://au.app.api.sinch.com, https://eu.app.api.sinch.com, or https://us.app.api.sinch.com. Basic authentication here means the API key/secret over verified TLS. Do not ship account credentials in a public mobile, browser, or desktop application.

Transport success and API success are checked separately. On HTTP 429, honor Retry-After before a bounded retry. Check account permissions and regional credentials for 401/403. A timeout or 5xx response after submitting a write can leave its outcome uncertain: reconcile before retrying, especially sends and resource creation. Metadata is correlation data, not an idempotency key. Inspect error bodies privately because they can contain phone numbers and message content.

Sinch Engage API reference

Chilkat Visual FoxPro Downloads

Visual FoxPro
LOCAL lnSuccess
LOCAL loConfig
LOCAL lcApiHost
LOCAL loHttp
LOCAL loUrl
LOCAL loResp
LOCAL loResult

lnSuccess = 0

*  Assumes Chilkat is unlocked. See Global Unlock Sample.

*  Store real credentials in private configuration, never in distributed client code.
loConfig = CreateObject('Chilkat.JsonObject')
loConfig.Strict = 1
lnSuccess = loConfig.LoadFile("sinch-engage.json")
IF (lnSuccess <> 1) THEN
    ? "Could not load private sinch-engage.json."
    RELEASE loConfig
    CANCEL
ENDIF

IF ((loConfig.JsonTypeOf("api_key") <> 1) OR (loConfig.StringOfEquals("api_key","",1) = 1) OR (loConfig.JsonTypeOf("api_secret") <> 1) OR (loConfig.StringOfEquals("api_secret","",1) = 1)) THEN
    ? "The private configuration must contain api_key and api_secret."
    RELEASE loConfig
    CANCEL
ENDIF

*  Choose the host for your Engage account: au, eu, or us. Do not guess from the recipient.
lcApiHost = "https://au.app.api.sinch.com"
loHttp = CreateObject('Chilkat.Http')
loHttp.RequireSslCertVerify = 1
loHttp.FollowRedirects = 0
loHttp.ConnectTimeout = 20
loHttp.ReadTimeout = 30
loHttp.Login = loConfig.StringOf("api_key")
loHttp.Password = loConfig.StringOf("api_secret")
loHttp.BasicAuth = 1
loHttp.SetRequestHeader("Accept","application/json")
loUrl = CreateObject('Chilkat.StringBuilder')
loResp = CreateObject('Chilkat.HttpResponse')
loResult = CreateObject('Chilkat.JsonObject')
loResult.Strict = 1
loUrl.Clear()
loUrl.Append(lcApiHost)
loUrl.Append("/v1/credits_management/account")
lnSuccess = loHttp.HttpNoBody("GET",loUrl.GetAsString(),loResp)
*  HttpJson/HttpNoBody also return false for HTTP 4xx/5xx responses.
IF ((lnSuccess <> 1) AND (loResp.StatusCode = 0)) THEN
    ? "HTTP transport failed. Inspect diagnostics privately; do not blindly retry a write."
    RELEASE loConfig
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loResult
    CANCEL
ENDIF

IF ((loResp.StatusCode <> 200)) THEN
    ? "Unexpected HTTP status: " + STR(loResp.StatusCode)
    IF (loResp.StatusCode = 429) THEN
        ? "Retry-After: " + loResp.GetHeaderField("Retry-After")
    ENDIF

    RELEASE loConfig
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loResult
    CANCEL
ENDIF

lnSuccess = loResult.Load(loResp.BodyStr)
IF (lnSuccess <> 1) THEN
    ? "Expected a JSON response."
    RELEASE loConfig
    RELEASE loHttp
    RELEASE loUrl
    RELEASE loResp
    RELEASE loResult
    CANCEL
ENDIF

*  A missing balance is not necessarily zero. Preserve decimals as text for display.
IF (loResult.HasMember("remaining_credits.MT_SMS") = 1) THEN
    ? "SMS balance: " + loResult.StringOf("remaining_credits.MT_SMS")
ENDIF

IF (loResult.HasMember("remaining_credits.MT_MMS") = 1) THEN
    ? "MMS balance: " + loResult.StringOf("remaining_credits.MT_MMS")
ENDIF

RELEASE loConfig
RELEASE loHttp
RELEASE loUrl
RELEASE loResp
RELEASE loResult