Skip to main content
GET
Get Plan Usage
For AI agents: a documentation index is at /llms.txt. Every page is also available as markdown, just append .md to the URL.

Overview

Get your studio’s current plan and credit usage. Use this to check remaining credits before submitting a project instead of parsing rejection errors — especially useful for agents and automated pipelines that batch work.

Response

string
User-friendly plan label, e.g. "Studio (Monthly)" or your AppSumo tier name
object
Media credit pool (clipping, captions, reframing, transcription, audiograms, editor processing)
object
AI credit pool (dubbing, AI voiceovers, emoji highlighter). Same {total, used, remaining} shape.
integer
How many automation projects can process at once on your plan (Creator: 3, Studio: 10)
integer
How long completed projects are kept before they expire
integer
Unix timestamp when the usage counters reset (your next billing cycle)
object | null
Auto top-up settings, or null if auto top-up was never set up. An admin turns it on and changes it in the reap app.

Credit Costs

Credits are consumed per billed minute of video. The multipliers by project type: See the Reap Credit System guide for details and examples.
While auto top-up is on, projects keep starting when media credits run out: the saved card is charged within seconds and the credits are added. Until then remaining shows 0. If the monthly limit is reached or a payment fails, new projects need credits again before they start.
If your plan was purchased through AppSumo, remaining may temporarily overstate spendable credits during the first 31 days after purchase (a refund-window safeguard). If a submission is rejected despite showing remaining credits, contact support.

Example Request

Example Response

Rate Limiting

This endpoint allows 60 requests per minute per API key. Each endpoint has its own budget, so this allowance is not shared with the rest of the API — see Rate limiting.

Next Steps

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful response

plan
string

User-friendly plan label, e.g. "Studio (Monthly)"

Example:

"Studio (Monthly)"

mediaCredits
object
aiCredits
object
maxConcurrentProjects
integer

How many automation projects can process at once on this plan

projectRetentionDays
integer

How long completed projects are kept before expiry

resetsOn
integer

Unix timestamp when the usage counters reset

autoTopUp
object | null

Auto top-up settings, or null if auto top-up was never set up. Turned on and changed in the reap app.