Skip to navigation

Retrieve your account

The account and environment the API key belongs to, its pinned API version and its default payment provider. All connected providers are at GET /v1/payment_providers.

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.

Response

The account.
idstring
object"account"
namestring
api_versionstring

The version requests use when they don’t send Runledger-Version.

default_currencystring
hosting_regionstring
Where the account's data is stored.
livemodeboolean
created_atdatetime
payment_providerobjectDeprecated

Deprecated. An alias of the account’s default provider, kept so existing readers keep working. An account can connect several providers: read them from GET /v1/payment_providers.

grant_expiry_noticestringOptional

How long before a credit grant expires credit_grant.expiring is sent. Set it in the configuration document.

Errors

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