API reference · Account
What the account's paid plan grants in the studio this period
GET/api/studio/planSigned in session
A paid plan the operator gave studio grants (lib/plans-config.ts): its studio credit, which video, sound and 3D jobs spend before the balance and nothing else spends, and what is left of it; a render plan's shots at once, where the plan raises the deployment's own; its share off the margin of every take, never below the provider's price. `grant` is null for an account whose plan grants nothing in the studio, or that has no plan. A 404 while media jobs are off. The signed in account; same origin for a write.
Answer 200
The grants, or null.
| Field | Type | What it is |
|---|---|---|
| grantrequired | object or null | |
| grant. | string | |
| grant. | integer | When this period and its credit end, unix ms. |
| grant. | integer | The period's studio credit, micro USD. |
| grant. | integer | What of it is not yet spent or held by a take being made. |
| grant. | integer or null | A render plan's shots at once, where the plan raises it. |
| grant. | integer | Off the margin of every take, basis points. |
Errors
- 401OpenAI shaped error.
- 404OpenAI shaped error.
- 429OpenAI shaped error.
Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.