Antimatter

POST/api/account/planSigned in session

`subscribe` with no active plan charges the price to the balance at once (402 `not_funded` for an account that never deposited, 402 `insufficient_credits` when the balance, holds counted, is short). With a plan active, the same plan with its cancellation pending resumes it, another plan switches at the next renewal at that plan's price, and the same plan otherwise is 409 `already_subscribed`. `cancel` stops the next renewal: the paid period runs to its end and nothing is refunded. A renewal the balance cannot cover lapses at the end of the period and sends plan.ended. An account the operator froze is refused every action here but cancel (403 `account_frozen`), and its plan is not renewed: it ends as `frozen` when the paid period does. Same origin only; ten changes a minute.

Request body

application/json, required

Request body fields
Field	Type	What it is
actionrequired	"subscribe"
planIdrequired	string

Example

{
  "action": "subscribe",
  "planId": "string"
}

Answer 200

What happened, and the plan as it now stands.

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

Errors

400OpenAI shaped error.
401OpenAI shaped error.
402OpenAI shaped error.
403OpenAI shaped error.
404OpenAI shaped error.
409OpenAI shaped error.
429OpenAI shaped error.
503OpenAI 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.