Antimatter

GET/api/account/planSigned in session

A plan is bought from the personal credit balance (stablecoin funded) for 30 days at a time and multiplies the per key rate limit for every key the account minted. With a holder tier as well, the larger multiplier applies, never the product. It raises rate limits only: there is no request priority. Reading renews the account's own plan when it is due. Off unless the operator set ANTIMATTER_PLANS; a period already paid is honoured to its end either way.

Answer 200

The offer and the account's plan.

Fields of the 200 answer
Field	Type	What it is
enabledrequired	boolean	False unless the operator set ANTIMATTER_PLANS.
periodDays	integer
baseRpm	integer	ANTIMATTER_API_RPM, the per key limit without a plan or holder tier.
plansrequired	array of object
plans[].id	string
plans[].name	string
plans[].priceMicros	integer	What one 30 day period costs, from the credit balance.
plans[].rateMultiplier	number	Multiplies ANTIMATTER_API_RPM per key.
plans[].includedCreditMicros	integer	Credit added at the start of every paid period; 0 for none.
plans[].requestsPerMinute	integer	The per key limit this plan gives on this deployment.
plans[].studio	object or null	What the plan grants in Nova Studio, or null for nothing. Studio credit is spent on video, sound and 3D jobs before the balance, and on nothing else.
plans[].studio.creditMicros	integer	Studio credit each paid period; 0 for none.
plans[].studio.maxActiveJobs	integer or null	A render plan's shots at once, where the plan raises the deployment's own; else null.
plans[].studio.jobMarkupDiscountBps	integer	Off the margin of every take, never below the provider's price; 0 for none.
currentrequired	object or null	The active subscription, paid through periodEnd. Its terms are the ones it was paid on.
current.subscriptionId	integer
current.planId	string
current.name	string
current.period	integer	1 for the first paid period, one more per renewal.
current.periodStart	integer
current.periodEnd	integer
current.priceMicros	integer
current.rateMultiplier	number
current.includedCreditMicros	integer
current.cancelAtPeriodEnd	boolean
current.nextPlanId	string or null	A switch waiting for renewal.
current.renewsAt	integer or null	When the next charge falls due; null when it will not renew.
current.renewalPriceMicros	integer or null	What that charge will be, from the configuration.
current.studio	object or null	What this period grants in Nova Studio and the studio credit left of it, as GET /api/studio/plan answers it; null for nothing.
current.studio.plan_id	string
current.studio.period_end	integer
current.studio.credit_micros	integer
current.studio.credit_left_micros	integer
current.studio.max_active_jobs	integer or null
current.studio.job_markup_discount_bps	integer
lastEndedrequired	object or null	With no active plan, how the last one ended.
lastEnded.planId	string
lastEnded.name	string
lastEnded.endedAt	integer
lastEnded.reason	string	One of "cancelled", "lapsed", "withdrawn", "frozen".
lastEnded.periodEnd	integer

Errors

401OpenAI 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.