Skip to navigation
API ReferenceCredits and holdsCredit types

Create a credit type

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.

Request

This endpoint expects an object.
keystringRequiredformat: "^[a-z][a-z0-9_]{1,63}$"
Your stable identifier for the credit type. Can't change.
namestringRequired
kindenumRequired

custom for your own unit, monetary for a prepaid balance in a currency.

Allowed values:
currencystringOptional

monetary only: the currency the balance is held in.

decimal_placesintegerOptional0-9Defaults to 2
Precision of amounts in this credit type.
unit_labelstringOptional
How to label one unit on invoices and receipts.
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 new 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
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error