Skip to main content
PATCH
Change subscription

Authorizations

Authorization
string
header
required

An API key from Settings → API keys, sent as Authorization: Bearer kb_live_…. A workspace key starts kb_; a personal key starts kbp_ and acts as its owner.

Headers

Idempotency-Key
string | null

A unique key (a UUID works) for this request. Retrying with the same key returns the first answer instead of running twice.

Maximum string length: 255
Kallabot-Version
enum<string>

The API version to answer as, a date (YYYY-MM-DD). Leave it out for the current version (2026-11-07). An unknown version is refused with 400 unsupported_api_version.

Available options:
2026-11-07
Example:

"2026-11-07"

Body

application/json
interval
enum<string> | null
Available options:
month,
year
cancel_at_period_end
boolean | null

Response

Successful Response

plan
string
required
status
string
required
interval
string | null
required
seats
SeatsOut · object
required
current_period_end
string | null
required
trial_ends_at
string | null
required
cancel_at_period_end
boolean
required
payment_state
string
required
card
CardOut · object | null
required
currency
string
required
auto_recharge
AutoRechargeOut · object
required
pool
PoolOut · object
required
upcoming_invoice
UpcomingInvoiceOut · object | null
required