This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Get usage balance

GET

https://api.signater.com/v1/account/usage/balance

Last modified:2026-11-04 04:23:46

Answers the envelope balance of the account: available, consumed and average per day, the balance and its projection per day, the lots with what is left of each, consumption per day and expirations per month. Administrators only.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.signater.com/v1/account/usage/balance?days=undefined&includeExpired=undefined&timeZone=undefined' \
--header 'x-api-token: <api-key>'

Responses

🟢200OK

application/json

Balance retrieved successfully

Bodyapplication/json

Example

{
    "cards": {
        "availableAmount": 0,
        "averageDailyConsumption": 0,
        "consumedAmount": 0
    },
    "projection": {
        "days": [
            "2019-08-24"
        ],
        "balance": [
            0
        ],
        "projection": [
            0
        ],
        "nextRenewalAtUtc": "2019-08-24T14:15:22.123Z"
    },
    "lots": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "origin": "Plan",
            "initialAmount": 0,
            "usedAmount": 0,
            "expiredAmount": 0,
            "availableAmount": 0,
            "grantedAtUtc": "2019-08-24T14:15:22.123Z",
            "expiresAtUtc": "2019-08-24T14:15:22.123Z",
            "expiredAtUtc": "2019-08-24T14:15:22.123Z"
        }
    ],
    "dailyConsumption": {
        "days": [
            "2019-08-24"
        ],
        "values": [
            0
        ]
    },
    "expirations": {
        "months": [
            "2019-08-24"
        ],
        "free": [
            0
        ],
        "paid": [
            0
        ]
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429

Modified at 2026-11-04 04:23:46

Get account

List usage statement