Skip to main content
PATCH
Change plan/price or seat count

Authorizations

Authorization
string
header
required

An aik_… programmatic API key (app.atako.ai → Settings → API keys) or a Supabase session JWT.

Body

application/json
planId
string<uuid>
priceId
string<uuid>
activeAgentsPurchased
integer

Response

id
string<uuid>
required
companyId
string<uuid>
required
planId
string<uuid>
required
status
enum<string>
required
Available options:
trialing,
active,
past_due,
canceled
activeAgentsPurchased
integer
required
planPriceId
string<uuid> | null
stripeSubscriptionId
string | null

Company admins only — omitted for members.

stripeCustomerId
string | null

Company admins only — omitted for members.

stripeScheduleId
string | null

Company admins only — omitted for members.

hasStripeSubscription
boolean

Whether a live Stripe subscription backs this row (false for a self-serve trial without card).

hasStripeCustomer
boolean

Whether the company has a Stripe customer.

currentPeriodStart
string<date-time>
currentPeriodEnd
string<date-time>
pendingActiveAgentsPurchased
integer | null

Target seat count of a scheduled reduction (AF-57), null when none is pending.

pendingReductionEffectiveAt
string<date-time> | null

When the pending reduction lands (= currentPeriodEnd at the time it was scheduled).

cancelAt
string<date-time> | null

End-of-period cancellation scheduled on Stripe (billing portal): when the service stops. Null when none is scheduled. On a canceled subscription: when the service actually stopped.

pendingPaymentActiveAgentsPurchased
integer | null

A licence increase whose prorated invoice awaits payment (3DS, declined card): the seat count once paid. Null when nothing is pending.

pendingPaymentInvoiceUrl
string | null

The hosted Stripe invoice to pay for pendingPaymentActiveAgentsPurchased. Company admins only — omitted for members.

trialSource
enum<string> | null
Available options:
self_serve,
admin_manual
trialEndAgentCount
integer | null
planName
string
planDescription
string
creditsPerAgentPerMonth
integer
billingInterval
enum<string> | null
Available options:
monthly,
annual
pricePerAgentCents
integer | null
createdAt
string<date-time>
updatedAt
string<date-time>