Credits and usage

Plan, credits and limits

Your plan, credit balance and the limits that apply now.

GET/v1/usage

Authentication

An API key with the usage:read scope, or the signed-in website.

Response

200 OK

planobject

code, name and source (subscription, trial or free).

creditsobject

available, held, consumed_last_30_days and lots, each batch of credits.

credit_weightsarray

Credits per page at each resolution.

limitsobject

Largest file, pages per job, jobs at a time and maximum DPI.

Errors

Status	Code	What to do
401	`unauthenticated`	The API key is missing, invalid, expired or revoked.
403	`insufficient_scope`	Use a key with the scope shown above.

Request

PHPPythonNode.jscURL

<?php
$api = getenv('RASTERNIVO_API_URL') ?: 'https://rasternivo-api.swiftinfocorp.com/v1';

$ch = curl_init("$api/usage");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('RASTERNIVO_API_KEY')],
]);
$usage = json_decode(curl_exec($ch), true);

echo $usage['plan']['name'], ' (', $usage['plan']['source'], '): ',
     $usage['credits']['available'], " credits available\n";

import os
import requests

API = os.environ.get("RASTERNIVO_API_URL", "https://rasternivo-api.swiftinfocorp.com/v1")

usage = requests.get(
    f"{API}/usage",
    headers={"Authorization": "Bearer " + os.environ["RASTERNIVO_API_KEY"]},
).json()

print(f"{usage['plan']['name']} ({usage['plan']['source']}): "
      f"{usage['credits']['available']} credits available")

const API = process.env.RASTERNIVO_API_URL ?? "https://rasternivo-api.swiftinfocorp.com/v1";

const res = await fetch(`${API}/usage`, {
  headers: { Authorization: `Bearer ${process.env.RASTERNIVO_API_KEY}` },
});
const usage = await res.json();

console.log(`${usage.plan.name} (${usage.plan.source}): ${usage.credits.available} credits available`);

curl "https://rasternivo-api.swiftinfocorp.com/v1/usage" \
  -H "Authorization: Bearer $RASTERNIVO_API_KEY"

Response 200

{
  "plan": { "code": "pro", "name": "Pro", "source": "trial" },
  "credits": {
    "available": 100, "held": 0, "consumed_last_30_days": 0,
    "lots": [
      { "source": "trial", "remaining": 100, "granted": 100,
        "granted_at": "2026-11-02T08:31:49Z", "expires_at": "2026-11-16T08:31:49Z" }
    ]
  },
  "credit_weights": [
    { "max_dpi": 150, "credits_per_page": 1 },
    { "max_dpi": 300, "credits_per_page": 3 },
    { "max_dpi": 600, "credits_per_page": 8 }
  ],
  "limits": {
    "max_active_jobs": 3, "max_dpi": 600, "max_pages_per_job": 500,
    "max_upload_bytes": 104857600, "result_ttl_seconds": 3600
  }
}