Account
The account endpoints of the Kashu API, with their parameters, objects, errors and examples. The guide explains how they fit together.
| Endpoint | What it does |
|---|
GET /v1/account | Retrieve the account the API key belongs to. |
The account object
| Field | Type | About |
|---|
object | string | Always "account". |
business_name | string or null | |
livemode | boolean | |
api_version | enum | One of 2026-11-06. |
default_store | string or null | An 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.
Parameters
| Name | In | Type | Required | About |
|---|
Kashu-Version | header | string | Optional | The 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);