Skip to navigation

Update a credit type

Renames a credit type or changes its metadata. key, kind, currency and decimal_places can’t change.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Path parameters

credit_typestringRequired

The credit type ID (ct_...) or key.

Request

This endpoint expects an object.
namestringOptional
unit_labelstring or nullOptional
metadatamap from strings to stringsOptional
Up to 50 keys of your own, with keys up to 40 characters and values up to 500 characters.

Response

The updated credit type.
idstring
object"credit_type"
keystring
namestring
kindenum
Allowed values:
decimal_placesinteger
metadatamap from strings to strings
Up to 50 keys of your own, with keys up to 40 characters and values up to 500 characters.
livemodeboolean
created_atdatetime
currencystringOptional
unit_labelstringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error