Credits
Your credit balance.
Headers
The endpoints on this page take these headers. Each endpoint's curl shows the ones it sends.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Ken-Version | header | string, one of: 2026-11-02, 1.1 | optional | The API version, a date in YYYY-MM-DD form. 1.1 is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and 404 where the path exists only in this version. A date that is not a version answers 400 unsupported_version; any other value that is not a version is treated as legacy. |
X-Ken-Workspace-Id | header | integer (int64) | optional | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers 400 workspace_required. A workspace you are not a member of answers 404 not_found. |
Get the credit balance
/v1/creditscredits.get- Permission
- Any workspace member except a Network member
- Rate limit
- 12,000 requests a minute per API key
Returns the workspace's credit balance: what is left, what data and AI work can spend now, the plan's included sends and free builds, and any bonus credits or launch offer. A white-label client workspace sees its parent workspace's shared balance.
A member without the billing permission gets the response without its billing details: includedMillicredits, purchasedMillicredits, debtMillicredits, reservedMonthlyMillicredits, includedExpiresAt, grandfatheredUntil, autoTopUp, reservedItems, pendingCreditPurchases and unpaidRenewals.
smtpSending is present while SMTP inboxes are billed per email: millicreditsPerEmail is the price of one campaign email sent from such an inbox, inboxesPerDomain, startDailyLimit, dailyStep and maxDailyLimit are the limits of an SMTP inbox, and paused is true while the workspace has an SMTP domain billed per email and the credits it bought cannot pay for one email: those sends wait until credits are bought (a plan's included credits and bonus or free credits do not pay for SMTP emails), while Google and Outlook inboxes keep sending. Every member gets it. It is absent otherwise.
Open to any workspace member.
curl -X GET "https://api.ken.so/v1/credits" \
-H "Authorization: Bearer $KENSO_API_KEY" \
-H "Ken-Version: 2026-11-02" \
-H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"Response 200
data is a CreditBalance.
Show the 28 response fields and an example
The fields and an example are also on this endpoint's Markdown page.
More in Workspace and account:Your accountWorkspacesSandboxesMembersPermission templatesAccess requestsCredit estimatesCredit ledgerCredit rate cardCredit savingsCredit savings rowsCredit spendWhite-label brandsCLI loginBug reportsAll resources