COcommpeak
Customer

Get account details and current balance

Gets the account email, available balance and temporary credit of the customer owning the token; balance is in USD and excludes temporary_credit. SMS-enabled accounts also get sms_balance, sms_currency and sms_platform (null when no SMS platform is activated). Responds 503 when the billing system is temporarily unavailable; retry later

get/customer

Request

  • Base URL
    https://api.commpeak.com/portal
  • URL
    https://api.commpeak.com/portal/customer
  • Auth
    API key in header Authorization

Response

Successful Response

Example response

{
  "customer": {
    "balance": 465.28538,
    "email": "test@example.com",
    "sms_balance": 99.68008768630997,
    "sms_currency": "USD",
    "sms_platform": 1001,
    "temporary_credit": 0
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.