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
| Property | Type | Description |
|---|---|---|
identifier | string | Unique organization identifier |
credits.used | integer | Number of credits used in the current billing period |
credits.total | integer | Total number of credits available in the current period |
credits.nextRenewalAt | string | Date when credits will be renewed (format: yyyy-MM-dd) |
credits.renewalAmount | integer | Number of credits that will be granted upon renewal |
uploads.used | long | Current upload storage used in bytes |
uploads.total | long | Maximum upload storage available in bytes |
plan.name | string | Name of the current subscription plan |
plan.status | string | Current status of the subscription (e.g. active) |
plan.nextBillingAt | string | Next billing date (format: yyyy-MM-dd) |