Get billing and usage summary

GET

/v1/billing/usage

Maintainer:Not configured

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/billing/usage?from=undefined&to=undefined&regulator=undefined' \
--header 'Authorization: Bearer <token>'

Responses

🟢200

application/json

Usage summary

Bodyapplication/json

Example

{
    "period": {
        "from": "2019-08-24T14:15:22.123Z",
        "to": "2019-08-24T14:15:22.123Z"
    },
    "billing_enabled": true,
    "wallet": {
        "balance_credits": 0,
        "deposited_credits": 0,
        "withdrawn_credits": 0
    },
    "usage": {
        "total_checks": 0,
        "total_estimated_cost_credits": 0
    },
    "connectors": [
        {
            "regulator": "nmc",
            "enabled": true,
            "monthly_allowance": 0,
            "used_this_month": 0,
            "remaining_allowance": 0,
            "cost_per_verification": 0,
            "usage_count": 0,
            "estimated_cost_credits": 0
        }
    ]
}

🟠401Unauthorized

🟠422ValidationError

Modified at 2026-04-24 12:59:15

Download evidence file

List worker imports