KashuDocs

Account

The account endpoints of the Kashu API, with their parameters, objects, errors and examples. The guide explains how they fit together.

EndpointWhat it does
GET /v1/accountRetrieve the account the API key belongs to.

The account object

FieldTypeAbout
objectstringAlways "account".
business_namestring or null
livemodeboolean
api_versionenumOne of 2026-11-06.
default_storestring or nullAn id that starts st_.
{
  "object": "account",
  "business_name": "Example Shop",
  "livemode": false,
  "api_version": "2026-11-06",
  "default_store": "st_1a2B3c4D5e6F7g8H9i0J1k2L"
}

GET /v1/account

Retrieve the account the API key belongs to.

Scope
account:read
Keys
Secret, or restricted with the scope below.
Idempotency-Key
Not used. A read changes nothing.
Answers
200 with the Account.

Parameters

NameInTypeRequiredAbout
Kashu-VersionheaderstringOptionalThe API version to answer in. Defaults to the key's pinned version.

Errors

Examples

curl https://api.kashupay.com/v1/account \
  -H "Authorization: Bearer $KASHU_SECRET_KEY"
const account = await kashu("GET", "/v1/account");
console.log(account.object);