Check SMS balance

curl --request POST \
  --url https://avraapi.com/api/v1/sms/balance \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-SECRET: <api-key>' \
  --data '{}'

const options = {
  method: 'POST',
  headers: {
    'X-API-KEY': '<api-key>',
    'X-API-SECRET': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://avraapi.com/api/v1/sms/balance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://avraapi.com/api/v1/sms/balance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>",
    "X-API-SECRET: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "success": true,
  "request_id": "7a5b17fa-0716-45e1-b109-378322b8769f",
  "data": {
    "source": "quicksend_direct",
    "balance_formatted": "473.52",
    "provider_response": {
      "balance": "473.52"
    }
  }
}

POST

sms

balance

Check SMS balance

curl --request POST \
  --url https://avraapi.com/api/v1/sms/balance \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-SECRET: <api-key>' \
  --data '{}'

const options = {
  method: 'POST',
  headers: {
    'X-API-KEY': '<api-key>',
    'X-API-SECRET': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({})
};

fetch('https://avraapi.com/api/v1/sms/balance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://avraapi.com/api/v1/sms/balance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>",
    "X-API-SECRET: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "success": true,
  "request_id": "7a5b17fa-0716-45e1-b109-378322b8769f",
  "data": {
    "source": "quicksend_direct",
    "balance_formatted": "473.52",
    "provider_response": {
      "balance": "473.52"
    }
  }
}

Use this endpoint to read the balance for the active QuickSend SMS integration in the selected project environment. The result depends on how that integration was configured.

Live Testing Guide: Before using Try it, create a Development project, then enter its Client ID and Client Secret. Configure the relevant provider for that project before sending the request.

API endpoint

POST

https://avraapi.com/api/v1/sms/balance

Request fields

This endpoint accepts an empty JSON object. AvraAPI resolves the configured SMS integration from your Project Client ID and X-ENV.

Field	Required	Rules
None	No	Send `{}` when your HTTP client requires a JSON body.

Outside the documentation Playground, keep the Project Client Secret on your backend. This endpoint is read-only and does not deduct AvraAPI credits.

Result fields

Field	Type	Notes
`source`	string	`apix_wallet` for a Managed integration, or `quicksend_direct` for a Manual (BYOK) integration.
`balance_formatted`	string	A human-readable balance value for the reported source.
`provider_response`	object	Present only for Manual (BYOK) integrations. It contains the provider’s balance response.

For a Managed integration, balance_formatted is the AvraAPI wallet balance in API credits. 1 USD equals 1,000,000 API credits. For a Manual (BYOK) integration, the balance is read from the connected QuickSend account and remains provider-formatted.

Request example

curl

curl --request POST "https://avraapi.com/api/v1/sms/balance" \
  --header "X-API-KEY: YOUR_PROJECT_CLIENT_ID" \
  --header "X-API-SECRET: YOUR_PROJECT_CLIENT_SECRET" \
  --header "X-ENV: development" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{}'

Response example — Manual (BYOK)

{
  "success": true,
  "request_id": "7a5b17fa-0716-45e1-b109-378322b8769f",
  "data": {
    "source": "quicksend_direct",
    "balance_formatted": "473.52",
    "provider_response": {
      "balance": "473.52"
    }
  }
}

Response example — Managed

{
  "success": true,
  "request_id": "3251caf2-3d8a-4232-a1fb-b4cfc4846888",
  "data": {
    "source": "apix_wallet",
    "balance_formatted": "285,417,005 credits"
  }
}

Error codes

HTTP	`error.code`	When it happens	What to do
`401`	`unauthorized`	Credentials are missing, invalid, inactive, or do not match the selected environment.	Check your backend secret configuration and `X-ENV`.
`422`	`provider_selection_failed`	No active QuickSend SMS integration can be selected for the project environment.	Configure or enable the QuickSend integration for the selected environment.
`422`	`http_error`	The active SMS integration is incomplete or its Manual (BYOK) credentials cannot be used.	Recheck the integration setup and credentials before retrying.
`429`	`rate_limit_exceeded`	The configured request limit was reached.	Respect `Retry-After` when present; do not retry in a tight loop.
`500`	`internal_error`	The balance check could not complete unexpectedly.	Retry only if your workflow permits it, retaining the request ID.
`503`	`http_error`	QuickSend could not be reached for a Manual (BYOK) balance check.	Retry later; a Managed balance does not call QuickSend.
`503`	`project_paused`	The project is paused.	Reactivate the project before retrying.

Keep the JSON request_id or X-APIX-Request-ID response header with your support record. It is the safest way for AvraAPI support to trace a request.

See the REST API guide for shared credential, privacy, and error-handling guidance.

Playground resources

The generated reference below lists this endpoint’s API standard details: request fields, authorizations, and response schema. The complete integration guide, request and response examples, and endpoint-specific error handling are above.

Authorizations

X-API-KEY

string

header

required

Your Development project's Client ID. Enter your own value in the Documentation Playground.

X-API-SECRET

string

header

required

Your Development project's Client Secret. Mintlify does not proxy these requests; the browser sends them directly to AvraAPI. Never enter a Production secret in the Documentation Playground.

Headers

X-ENV

enum<string>

default:development

Selects the Development credential environment. The Documentation Playground exposes Development values only; normal backend integrations may use their documented Production credentials outside this tool.

Available options:

dev,

development

string

Requests a JSON response where the selected operation supports JSON.

Example:

"application/json"

X-Privacy-Mode

boolean

default:false

Optional privacy override. Turn this on to request that AvraAPI suppress request-payload storage in observability logs for this request.

Example:

true

Body

application/json

The body is of type object.

Response

Balance associated with the selected SMS integration.

success

enum<boolean>

required

Available options:

true

request_id

string<uuid>

required

Include this value when contacting AvraAPI support.

data

object

required

Operation-specific result data.

Show child attributes

Last modified on October 1, 2026

Introduction

Currencies

SMS

Security

Location

Utilities

Check SMS balance

API endpoint

Request fields

Result fields

Request example

Response example — Manual (BYOK)

Response example — Managed

Error codes

Playground resources

Authorizations

Headers

Body

Response

​API endpoint

​Request fields

​Result fields

​Request example

​Response example — Manual (BYOK)

​Response example — Managed

​Error codes

​Playground resources

Authorizations

Headers

Body

Response

API endpoint

Request fields

Result fields

Request example

Response example — Manual (BYOK)

Response example — Managed

Error codes

Playground resources