Usage

3 min readMarch 26, 2026

This endpoint allows you to check your organization's current credit usage, upload storage, and subscription plan details.

GET Endpoint

https://get.renderform.io/api/v1/usage

Example request

curl --location \
     --request GET 'https://get.renderform.io/api/v1/usage' \
     --header 'X-API-KEY: <API_KEY>' \
     --header 'Content-Type: application/json'

Sample response

{
  "identifier": "my-organization-identifier",
  "credits": {
    "used": 450,
    "total": 5000,
    "nextRenewalAt": "2026-04-01",
    "renewalAmount": 5000
  },
  "uploads": {
    "used": 524288000,
    "total": 1073741824
  },
  "plan": {
    "name": "Business",
    "status": "active",
    "nextBillingAt": "2026-04-01"
  }
}

Response body

PropertyTypeDescription
identifierstringUnique organization identifier
credits.usedintegerNumber of credits used in the current billing period
credits.totalintegerTotal number of credits available in the current period
credits.nextRenewalAtstringDate when credits will be renewed (format: yyyy-MM-dd)
credits.renewalAmountintegerNumber of credits that will be granted upon renewal
uploads.usedlongCurrent upload storage used in bytes
uploads.totallongMaximum upload storage available in bytes
plan.namestringName of the current subscription plan
plan.statusstringCurrent status of the subscription (e.g. active)
plan.nextBillingAtstringNext billing date (format: yyyy-MM-dd)