Get Account Balance - SMSOnline API Doc

Request

Path Params

userId

string

required

Your User Id

Example:

Query Params

apiKey

string

required

Issued API key

Example:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

ok

boolean

required

body

object

required

userId

string

required

stripeId

string

required

cryptomusId

null

required

balance

integer

required

Your account balance

status

null

required

lang

null

required

referral

null

required

totalCharges

string

required

Cumulative top-up amount

couponCount

integer

required

Number of coupons held

currentDiscountRate

string

required

Current account discount rate

vipSupport

boolean

required

Whether dedicated support is available on Telegram

vipTelegram

string

required

Dedicated manager's Telegram ID (if enabled)

discountRates

array [array]

required

Currently set discount rate thresholds

Example

{
    "ok": true,
    "body": {
        "userId": "userId",
        "stripeId": "stripeId",
        "cryptomusId": null,
        "balance": 500,
        "status": null,
        "lang": null,
        "referral": null,
        "totalCharges": "500",
        "couponCount": 1,
        "currentDiscountRate": "-20%",
        "vipSupport": false,
        "vipTelegram": "",
        "discountRates": [
            [
                8000,
                0.8,
                "-20%"
            ],
            [
                6000,
                0.85,
                "-15%"
            ],
            [
                4000,
                0.9,
                "-10%"
            ],
            [
                2000,
                0.95,
                "-5%"
            ],
            [
                0,
                1,
                "0%"
            ]
        ]
    }
}