Credits

Get Studio Credit balance and what each operation costs.

Read-only summary of the current Studio Credit balance, monthly bucket allocation/use, and perpetual credit balance, plus costs: what each operation costs, the same list the Billing page shows (each line names the ledger ops its charges carry) — and the ledger behind the number: usage (what the credits actually WENT TO, each charge named the way the Billing page names it, with the screenplay it was spent on; grants and refunds are shown but are not spending), usageGroups (repeated charges on one project on one UTC day folded into one entry, as the Billing page shows them) and held (the credits the writer's work is HOLDING right now — reserved for jobs still in flight, not yet spent or given back — with heldTotal summed over EVERY hold, heldCount and a plain heldNote). credits.billing is how credits are bought: the saved top-up card, this month's spend against the monthly spending cap, auto top-up and topupUrl (buying happens only in the app; set auto top-up and the cap with PATCH /credits/billing). ?recent=N caps the two activity pages (default 10, max 30; 0 omits both pages); the balance and the price list are never capped. A pitch deck is priced by the second: 1 credit a second to render at 480p, plus 1 credit a second to finish at 720p (2 credits a second in all; a 1080p finish is 4 credits a second instead). Planning is free. The exact price is quoted per shot once the plan is ready, before anything renders; location plates and on-screen text are itemized in the same quotes. A trailer is priced by the second: 1 credit a second to render at 480p, plus 1 credit a second to finish at 720p (2 credits a second in all; a 1080p finish is 4 credits a second instead). Planning is free. The exact price is quoted per shot once the plan is ready, before anything renders; location plates and on-screen text are itemized in the same quotes. Use this before submitting expensive generation jobs so agents can short-circuit with insufficient_credits guidance instead of triggering reservations.

get/credits

Request

  • Base URL: https://docs.sleeperhit.studio/api/v1
  • URL: https://docs.sleeperhit.studio/api/v1/credits
  • Auth: HTTP bearer

Query parameters

recentinteger

How many recent usage and held lines to return, newest first — ONE cap applied to both pages, on the rule every surface shares. Default 10, max 30; a negative behaves as 0 and anything past the max caps at it; 0 omits both pages (the balance and the price list stay). A non-integer is refused with validation_failed.

Response

Credit summary.

usageCountinteger required

How many ledger entries this writer has in TOTAL across EVERY page (not just the usage page here). With the page length it names "N of M entries shown", whenever more exists.

heldTotalinteger required

The credits the writer's work is HOLDING right now, summed over EVERY hold — not just the held page. What is not spent comes back.

heldCountinteger required

How many holds are tying up those credits.

heldNotestring required

A plain sentence for the writer: what is held and that what is not spent comes back, or that nothing is holding credits right now.

Changes

No recorded changes to this operation across all 1 revision of this API.