POST
Issue Service Key

Authorizations

Authorization
string
header
required

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

Query Parameters

organization_id
integer
required

Org to issue the key to

Body

application/json
tier_name
string
required
Maximum string length: 32
name
string | null
Maximum string length: 128
is_test
boolean
default:false

If true, the issued key starts with 'pk_test_' and is intended for sandbox use. If false, it starts with 'pk_live_'.

expires_at
string<date-time> | null

Response

Successful Response

One-time response when a new service key is issued. The api_key field is the cleartext key — the only time it is ever sent over the wire. The customer must store it; the operator cannot recover it later (only the bcrypt hash is persisted).

key
ServiceKeyResponse · object
required

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.

api_key
string
required

Cleartext key. SHOWN ONCE. Cannot be retrieved later — the operator only stores the bcrypt hash. The customer must copy this immediately.