PATCH
Update Service Key

Authorizations

Authorization
string
header
required

Interactive user session: the login JWT, sent as Authorization: Bearer <token>.

Path Parameters

key_id
integer
required

Body

application/json

Admin-only: update tier, override rate, add-ons, reserved slots, Enterprise floor-override metadata, expiry. Customers cannot edit most of these fields тАФ that is why this lives in the admin endpoints.

reason
string
required
Required string length: 10 - 500
name
string | null
Maximum string length: 128
tier_name
string | null
Maximum string length: 32
overage_rate_usd_per_min_override
included_minutes_per_month_override
integer | null
Required range: x >= 0
reserved_concurrent_slots
integer | null
Required range: x >= 0
addons
Addons ┬╖ object | null
commitment_months
integer | null
Required range: x >= 0
floor_override_reason
string | null
expires_at
string<date-time> | null
is_active
boolean | null

Response

Successful Response

Service key metadata тАФ does NOT include the actual key value. The cleartext key is shown to the customer exactly once via ServiceKeyIssuedResponse at creation time.

id
integer
required
organization_id
integer
required
key_prefix
string
required

First 12 characters of the key (e.g. 'pk_live_abcd'). Safe to display in the UI for identification.

tier_name
string
required
reserved_concurrent_slots
integer
required
commitment_months
integer
required
used_minutes_this_month
integer
required
is_active
boolean
required
created_at
string<date-time>
required
name
string | null
overage_rate_usd_per_min_override
string | null
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
included_minutes_per_month_override
integer | null
addons
Addons ┬╖ object
floor_override_reason
string | null
floor_override_approved_by
integer | null
month_anchor
string<date> | null
last_used_at
string<date-time> | null
expires_at
string<date-time> | null
revoked_at
string<date-time> | null
created_by
integer | null