Subscriptions

Subscribe your company to a plan

Company-admin only. Requires the company's Stripe customer to already have a card on file unless USE_STRIPE=false.

post/subscriptions/company

Request

  • Base URL: https://api.atako.ai
  • URL: https://api.atako.ai/subscriptions/company
  • Auth: HTTP bearer

Request body

planIdstring uuid required
priceIdstring uuid required
activeAgentsPurchasedinteger

Response

idstring uuid required
companyIdstring uuid required
planIdstring uuid required
planPriceIdstring uuid nullable
stripeSubscriptionIdstring nullable

Company admins only — omitted for members.

stripeCustomerIdstring nullable

Company admins only — omitted for members.

stripeScheduleIdstring nullable

Company admins only — omitted for members.

hasStripeSubscriptionboolean

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

hasStripeCustomerboolean

Whether the company has a Stripe customer.

status'trialing' | 'active' | 'past_due' | 'canceled' required
currentPeriodStartstring date-time
currentPeriodEndstring date-time
activeAgentsPurchasedinteger required
pendingActiveAgentsPurchasedinteger nullable

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

pendingReductionEffectiveAtstring date-time nullable

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

cancelAtstring date-time nullable

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.

pendingPaymentActiveAgentsPurchasedinteger nullable

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

pendingPaymentInvoiceUrlstring nullable

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

trialSource'self_serve' | 'admin_manual' nullable
trialEndAgentCountinteger nullable
planNamestring
planDescriptionstring
creditsPerAgentPerMonthinteger
billingInterval'monthly' | 'annual' nullable
pricePerAgentCentsinteger nullable
createdAtstring date-time
updatedAtstring date-time

Changes

No recorded changes to this operation across all 2 revisions of this API.