REST API

Credits

Retrieve tenant-scoped monthly Paperpin credit usage, consumed credits, and plan limits for billing-aware integrations.

Base URL: https://paperpin.io/api/v1

Every request requires Authorization: Bearer pp_....

Get credit usage

GET /credits

Returns the tenant's current monthly credit usage, monthly credit limit, and remaining credits.

{
  "data": {
    "credits_used": 13,
    "credits_limit": 100,
    "credits_remaining": 87
  }
}

Insights

Retrieve aggregate Paperpin monitoring statistics, trend timelines, checks, failures, changes, and credit usage.

Errors and rate limits

Understand Paperpin REST API error codes, validation failures, rate-limit responses, and safe retry behavior.